Internal change

PiperOrigin-RevId: 438865442

official/utils/docs/build_orbit_api_docs.py

+# Copyright 2022 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.
+
+r"""Tool to generate api_docs for tensorflow_models/official library.
+
+Example:
+
+$> pip install -U git+https://github.com/tensorflow/docs
+$> python build_orbit_api_docs \
+ --output_dir=/tmp/api_docs
+"""
+from absl import app
+from absl import flags
+from absl import logging
+
+import orbit
+
+from tensorflow_docs.api_generator import generate_lib
+from tensorflow_docs.api_generator import public_api
+
+from official.utils.docs import build_api_docs_lib
+
+FLAGS = flags.FLAGS
+
+flags.DEFINE_string('output_dir', None, 'Where to write the resulting docs to.')
+flags.DEFINE_string('code_url_prefix',
+                    'https://github.com/tensorflow/models/blob/master/orbit',
+                    'The url prefix for links to code.')
+
+flags.DEFINE_bool('search_hints', True,
+                  'Include metadata search hints in the generated files')
+
+flags.DEFINE_string('site_path', '/api_docs/python',
+                    'Path prefix in the _toc.yaml')
+
+
+PROJECT_SHORT_NAME = 'orbit'
+PROJECT_FULL_NAME = 'Orbit'
+
+
+def gen_api_docs(code_url_prefix, site_path, output_dir, project_short_name,
+                 project_full_name, search_hints):
+  """Generates api docs for the tensorflow docs package."""
+  build_api_docs_lib.hide_module_model_and_layer_methods()
+
+  doc_generator = generate_lib.DocGenerator(
+      root_title=project_full_name,
+      py_modules=[(project_short_name, orbit)],
+      code_url_prefix=code_url_prefix,
+      search_hints=search_hints,
+      site_path=site_path,
+      callbacks=[public_api.explicit_package_contents_filter],
+  )
+
+  doc_generator.build(output_dir)
+  logging.info('Output docs to: %s', output_dir)
+
+
+def main(argv):
+  if len(argv) > 1:
+    raise app.UsageError('Too many command-line arguments.')
+
+  gen_api_docs(
+      code_url_prefix=FLAGS.code_url_prefix,
+      site_path=FLAGS.site_path,
+      output_dir=FLAGS.output_dir,
+      project_short_name=PROJECT_SHORT_NAME,
+      project_full_name=PROJECT_FULL_NAME,
+      search_hints=FLAGS.search_hints)
+
+
+if __name__ == '__main__':
+  flags.mark_flag_as_required('output_dir')
+  app.run(main)

official/utils/docs/build_orbit_api_docs_test.py

+# Copyright 2022 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.
+
+"""Tests for official.tools.build_docs."""
+
+import os
+import shutil
+
+import tensorflow as tf
+
+from official.utils.docs import build_orbit_api_docs
+
+
+class BuildDocsTest(tf.test.TestCase):
+
+  def setUp(self):
+    super(BuildDocsTest, self).setUp()
+    self.workdir = self.get_temp_dir()
+    if os.path.exists(self.workdir):
+      shutil.rmtree(self.workdir)
+    os.makedirs(self.workdir)
+
+  def test_api_gen(self):
+
+    build_orbit_api_docs.gen_api_docs(
+        code_url_prefix="https://github.com/tensorflow/models/blob/master/orbit",
+        site_path="/api_docs/python",
+        output_dir=self.workdir,
+        project_short_name="orbit",
+        project_full_name="Orbit",
+        search_hints=True)
+
+    # Check that the "defined in" section  working
+    with open(os.path.join(self.workdir, "orbit.md")) as f:
+      content = f.read()
+    self.assertIn("__init__.py", content)
+
+
+if __name__ == "__main__":
+  tf.test.main()