build_tft_beam_docs.py

#
# Copyright 2017 Google Inc. 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"""Generate docs for `tft.beam`.

This requires a local installation of `tft` and `tensoirflow_docs`

```
$ pip install tensorflow_transform git+https://github.com/tensorflow/docs
```

```
python build_tft_beam_docs.py --output_dir=/tmp/tft_beam_api/
```

"""
from absl import app
from absl import flags

from tensorflow_docs.api_generator import doc_controls
from tensorflow_docs.api_generator import generate_lib
from tensorflow_docs.api_generator import public_api
import tensorflow_transform.beam as tft_beam


flags.DEFINE_string('output_dir', '/tmp/tft_beam_api/',
                    'The path to output the files to')

flags.DEFINE_string(
    'code_url_prefix',
    'https://github.com/tensorflow/transform/tree/master/tensorflow_transform',
    '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', 'tfx/transform/api_docs/python',
                    'Path prefix in the _toc.yaml')

FLAGS = flags.FLAGS


def main(args):
  if args[1:]:
    raise ValueError('Unrecognized Command line args', args[1:])

  doc_controls.do_not_generate_docs(tft_beam.analyzer_impls)

  doc_generator = generate_lib.DocGenerator(
      root_title='TFT-Beam',
      py_modules=[('tft_beam', tft_beam)],
      code_url_prefix=FLAGS.code_url_prefix + '/beam',
      search_hints=FLAGS.search_hints,
      site_path=FLAGS.site_path,
      callbacks=[
          public_api.explicit_package_contents_filter,
          public_api.local_definitions_filter
      ])

  doc_generator.build(FLAGS.output_dir)


if __name__ == '__main__':
  app.run(main)