#

# 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`.

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

```

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

```

```

python build_tft_docs.py --output_dir=/tmp/tft-api

```

"""

from absl import app, flags

from tensorflow_docs.api_generator import generate_lib, public_api

import tensorflow_transform as transform

flags.DEFINE_string("output_dir", "/tmp/tft_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_generator = generate_lib.DocGenerator(

root_title="TF-Transform",

py_modules=[("tft", transform)],

code_url_prefix=FLAGS.code_url_prefix,

search_hints=FLAGS.search_hints,

site_path=FLAGS.site_path,

callbacks=[public_api.explicit_package_contents_filter],

)

doc_generator.build(FLAGS.output_dir)

if __name__ == "__main__":

app.run(main)