Module: tfdocs.doc_generator_visitor

A traverse visitor for processing documentation.

Classes

class ApiTree: Public API index.

class ApiTreeNode: A node in the ApiTree.

class DocGeneratorVisitor: A visitor that generates docs for a python object when called.

class PathTree: An index/tree of all object-paths in the API.

class PathTreeNode: Represents a path to an object in the API, an object can have many paths.

Functions

maybe_singleton(...): Returns True if py_object might be a singleton value .

Type Aliases

ApiPath

annotations Instance of __future__._Feature