87b201b1a3
This is pretty bare-bones for now, but I need something to start wiring up the rest of the automation. Plus this should be easy enough for anyone to riff on once it's in place. I couldn't find a great location within the existing directory structure for this, so LMK if it should be re-homed. PiperOrigin-RevId: 484426543
86 lines
2.7 KiB
Python
86 lines
2.7 KiB
Python
# 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"""MediaPipe reference docs generation script.
|
|
|
|
This script generates API reference docs for the `mediapipe` PIP package.
|
|
|
|
$> pip install -U git+https://github.com/tensorflow/docs mediapipe
|
|
$> python build_py_api_docs.py
|
|
"""
|
|
|
|
import os
|
|
|
|
from absl import app
|
|
from absl import flags
|
|
|
|
from tensorflow_docs.api_generator import generate_lib
|
|
from tensorflow_docs.api_generator import public_api
|
|
|
|
try:
|
|
# mediapipe has not been set up to work with bazel yet, so catch & report.
|
|
import mediapipe # pytype: disable=import-error
|
|
except ImportError as e:
|
|
raise ImportError('Please `pip install mediapipe`.') from e
|
|
|
|
|
|
PROJECT_SHORT_NAME = 'mp'
|
|
PROJECT_FULL_NAME = 'MediaPipe'
|
|
|
|
_OUTPUT_DIR = flags.DEFINE_string(
|
|
'output_dir',
|
|
default='/tmp/generated_docs',
|
|
help='Where to write the resulting docs.')
|
|
|
|
_URL_PREFIX = flags.DEFINE_string(
|
|
'code_url_prefix',
|
|
'https://github.com/google/mediapipe/tree/master/mediapipe',
|
|
'The url prefix for links to code.')
|
|
|
|
_SEARCH_HINTS = flags.DEFINE_bool(
|
|
'search_hints', True,
|
|
'Include metadata search hints in the generated files')
|
|
|
|
_SITE_PATH = flags.DEFINE_string('site_path', '/mediapipe/api_docs/python',
|
|
'Path prefix in the _toc.yaml')
|
|
|
|
|
|
def gen_api_docs():
|
|
"""Generates API docs for the mediapipe package."""
|
|
|
|
doc_generator = generate_lib.DocGenerator(
|
|
root_title=PROJECT_FULL_NAME,
|
|
py_modules=[(PROJECT_SHORT_NAME, mediapipe)],
|
|
base_dir=os.path.dirname(mediapipe.__file__),
|
|
code_url_prefix=_URL_PREFIX.value,
|
|
search_hints=_SEARCH_HINTS.value,
|
|
site_path=_SITE_PATH.value,
|
|
# This callback ensures that docs are only generated for objects that
|
|
# are explicitly imported in your __init__.py files. There are other
|
|
# options but this is a good starting point.
|
|
callbacks=[public_api.explicit_package_contents_filter],
|
|
)
|
|
|
|
doc_generator.build(_OUTPUT_DIR.value)
|
|
|
|
print('Docs output to:', _OUTPUT_DIR.value)
|
|
|
|
|
|
def main(_):
|
|
gen_api_docs()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
app.run(main)
|