STT-tensorflow/tensorflow/tools/docs/build_java_api_docs.py
Mark Daoust 357e80f364 Add "yes | configure" step to java-docs script.
PiperOrigin-RevId: 326457785
Change-Id: I4e28fd30343ef386d3bfc748c70337a60c21143f
2020-08-13 09:17:59 -07:00

87 lines
2.9 KiB
Python

# Lint as: python3
# Copyright 2018 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""Generate Java reference docs for TensorFlow.org."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import pathlib
import shutil
import subprocess
import tempfile
from absl import app
from absl import flags
from tensorflow_docs.api_generator import gen_java
FLAGS = flags.FLAGS
# These flags are required by infrastructure, not all of them are used.
flags.DEFINE_string('output_dir', None,
("Use this branch as the root version and don't"
' create in version directory'))
flags.DEFINE_string('site_path', 'api_docs/java',
'Path prefix in the _toc.yaml')
flags.DEFINE_string('code_url_prefix', None,
'[UNUSED] The url prefix for links to code.')
flags.DEFINE_bool(
'search_hints', True,
'[UNUSED] Include metadata search hints in the generated files')
# Use this flag to disable bazel generation if you're not setup for it.
flags.DEFINE_bool('gen_ops', True, 'enable/disable bazel-generated ops')
# __file__ is the path to this file
DOCS_TOOLS_DIR = pathlib.Path(__file__).resolve().parent
TENSORFLOW_ROOT = DOCS_TOOLS_DIR.parents[2]
SOURCE_PATH = TENSORFLOW_ROOT / 'tensorflow/java/src/main/java'
OP_SOURCE_PATH = (
TENSORFLOW_ROOT /
'bazel-bin/tensorflow/java/ops/src/main/java/org/tensorflow/op')
def main(unused_argv):
merged_source = pathlib.Path(tempfile.mkdtemp())
shutil.copytree(SOURCE_PATH, merged_source / 'java')
if FLAGS.gen_ops:
# `$ yes | configure`
yes = subprocess.Popen(['yes', ''], stdout=subprocess.PIPE)
configure = subprocess.Popen([TENSORFLOW_ROOT / 'configure'],
stdin=yes.stdout,
cwd=TENSORFLOW_ROOT)
configure.communicate()
subprocess.check_call(
['bazel', 'build', '//tensorflow/java:java_op_gen_sources'],
cwd=TENSORFLOW_ROOT)
shutil.copytree(OP_SOURCE_PATH, merged_source / 'java/org/tensorflow/ops')
gen_java.gen_java_docs(
package='org.tensorflow',
source_path=merged_source / 'java',
output_dir=pathlib.Path(FLAGS.output_dir),
site_path=pathlib.Path(FLAGS.site_path))
if __name__ == '__main__':
flags.mark_flags_as_required(['output_dir'])
app.run(main)