parameters: (full_name, py_object, parser_config)
return_statement: return page_info
docstring: Return a PageInfo object describing a given object from the TF API.
  
    This function uses _parse_md_docstring to parse the docs pertaining to
    `object`.
  
    This function resolves '@{symbol}' references in the docstrings into links to
    the appropriate location. It also adds a list of alternative names for the
    symbol automatically.
  
    It assumes that the docs for each object live in a file given by
    `documentation_path`, and that relative links to files within the
    documentation are resolvable.
  
    Args:
      full_name: The fully qualified name of the symbol to be
        documented.
      py_object: The Python object to be documented. Its documentation is sourced
        from `py_object`'s docstring.
      parser_config: A ParserConfig object.
  
    Returns:
      Either a `_FunctionPageInfo`, `_ClassPageInfo`, or a `_ModulePageInfo`
      depending on the type of the python object being documented.
  
    Raises:
      RuntimeError: If an object is encountered for which we don't know how
        to make docs.
docstring_summary: Return a PageInfo object describing a given object from the TF API.
docstring_tokens: Return a PageInfo object describing a given object from the TF API .
function: def docs_for_object(full_name, py_object, parser_config):
    """Return a PageInfo object describing a given object from the TF API.
  
    This function uses _parse_md_docstring to parse the docs pertaining to
    `object`.
  
    This function resolves '@{symbol}' references in the docstrings into links to
    the appropriate location. It also adds a list of alternative names for the
    symbol automatically.
  
    It assumes that the docs for each object live in a file given by
    `documentation_path`, and that relative links to files within the
    documentation are resolvable.
  
    Args:
      full_name: The fully qualified name of the symbol to be
        documented.
      py_object: The Python object to be documented. Its documentation is sourced
        from `py_object`'s docstring.
      parser_config: A ParserConfig object.
  
    Returns:
      Either a `_FunctionPageInfo`, `_ClassPageInfo`, or a `_ModulePageInfo`
      depending on the type of the python object being documented.
  
    Raises:
      RuntimeError: If an object is encountered for which we don't know how
        to make docs.
    """
  
    # Which other aliases exist for the object referenced by full_name?
    master_name = parser_config.reference_resolver.py_master_name(full_name)
    duplicate_names = parser_config.duplicates.get(master_name, [full_name])
  
    # TODO(wicke): Once other pieces are ready, enable this also for partials.
    if (tf_inspect.ismethod(py_object) or tf_inspect.isfunction(py_object) or
        # Some methods in classes from extensions come in as routines.
        tf_inspect.isroutine(py_object)):
      page_info = _FunctionPageInfo(master_name)
      page_info.set_signature(py_object, parser_config.reverse_index)
  
    elif tf_inspect.isclass(py_object):
      page_info = _ClassPageInfo(master_name)
      page_info.collect_docs_for_class(py_object, parser_config)
  
    elif tf_inspect.ismodule(py_object):
      page_info = _ModulePageInfo(master_name)
      page_info.collect_docs_for_module(parser_config)
  
    else:
      raise RuntimeError('Cannot make docs for object %s: %r' % (full_name,
                                                                 py_object))
  
    relative_path = os.path.relpath(
        path='.', start=os.path.dirname(documentation_path(full_name)) or '.')
  
    page_info.set_doc(_parse_md_docstring(
        py_object, relative_path, parser_config.reference_resolver))
  
    page_info.set_aliases(duplicate_names)
  
    page_info.set_guides(_get_guides_markdown(
        duplicate_names, parser_config.guide_index, relative_path))
  
    page_info.set_defined_in(_get_defined_in(py_object, parser_config))
  
    return page_info
function_tokens: def docs_for_object ( full_name , py_object , parser_config ) : # Which other aliases exist for the object referenced by full_name? master_name = parser_config . reference_resolver . py_master_name ( full_name ) duplicate_names = parser_config . duplicates . get ( master_name , [ full_name ] ) # TODO(wicke): Once other pieces are ready, enable this also for partials. if ( tf_inspect . ismethod ( py_object ) or tf_inspect . isfunction ( py_object ) or # Some methods in classes from extensions come in as routines. tf_inspect . isroutine ( py_object ) ) : page_info = _FunctionPageInfo ( master_name ) page_info . set_signature ( py_object , parser_config . reverse_index ) elif tf_inspect . isclass ( py_object ) : page_info = _ClassPageInfo ( master_name ) page_info . collect_docs_for_class ( py_object , parser_config ) elif tf_inspect . ismodule ( py_object ) : page_info = _ModulePageInfo ( master_name ) page_info . collect_docs_for_module ( parser_config ) else : raise RuntimeError ( 'Cannot make docs for object %s: %r' % ( full_name , py_object ) ) relative_path = os . path . relpath ( path = '.' , start = os . path . dirname ( documentation_path ( full_name ) ) or '.' ) page_info . set_doc ( _parse_md_docstring ( py_object , relative_path , parser_config . reference_resolver ) ) page_info . set_aliases ( duplicate_names ) page_info . set_guides ( _get_guides_markdown ( duplicate_names , parser_config . guide_index , relative_path ) ) page_info . set_defined_in ( _get_defined_in ( py_object , parser_config ) ) return page_info