aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/tools/docs/generate_lib.py
diff options
context:
space:
mode:
authorGravatar Avijit <Avijit.Chakraborty@intel.com>2018-08-12 16:21:41 -0700
committerGravatar Avijit <Avijit.Chakraborty@intel.com>2018-08-12 16:21:41 -0700
commit9523a98466d16cf01fc76a67b489f1124cf626ac (patch)
treebd4c460b67fab60c2fb1a6c56bf22d1cbb5391e6 /tensorflow/tools/docs/generate_lib.py
parent93e950c308071071f35d6dcb35b9f91b8a34876c (diff)
parent1a22b0b982fa1a953651b98af8f3cd30542048fd (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'tensorflow/tools/docs/generate_lib.py')
-rw-r--r--tensorflow/tools/docs/generate_lib.py15
1 files changed, 11 insertions, 4 deletions
diff --git a/tensorflow/tools/docs/generate_lib.py b/tensorflow/tools/docs/generate_lib.py
index 4f70a69364..4bc8cbf4b4 100644
--- a/tensorflow/tools/docs/generate_lib.py
+++ b/tensorflow/tools/docs/generate_lib.py
@@ -235,12 +235,16 @@ def add_dict_to_dict(add_from, add_to):
# Exclude some libraries in contrib from the documentation altogether.
def _get_default_private_map():
- return {'tf.test': ['mock']}
+ return {
+ 'tf.contrib.autograph': ['utils', 'operators'],
+ 'tf.test': ['mock'],
+ 'tf.compat': ['v1', 'v2'],
+ }
# Exclude members of some libraries.
def _get_default_do_not_descend_map():
- # TODO(wicke): Shrink this list once the modules get sealed.
+ # TODO(markdaoust): Use docs_controls decorators, locally, instead.
return {
'tf': ['cli', 'lib', 'wrappers'],
'tf.contrib': [
@@ -284,10 +288,13 @@ def _get_default_do_not_descend_map():
}
-def extract(py_modules, private_map, do_not_descend_map):
+def extract(py_modules,
+ private_map,
+ do_not_descend_map,
+ visitor_cls=doc_generator_visitor.DocGeneratorVisitor):
"""Extract docs from tf namespace and write them to disk."""
# Traverse the first module.
- visitor = doc_generator_visitor.DocGeneratorVisitor(py_modules[0][0])
+ visitor = visitor_cls(py_modules[0][0])
api_visitor = public_api.PublicAPIVisitor(visitor)
api_visitor.set_root_name(py_modules[0][0])
add_dict_to_dict(private_map, api_visitor.private_map)