View source on GitHub
|
Given a dict of full names to python objects, generate an index page.
tfdocs.parser.generate_global_index(
library_name, index, reference_resolver
)
The index page generated contains a list of links for all symbols in index
that have their own documentation page.
Args | |
|---|---|
library_name
|
The name for the documented library to use in the title. |
index
|
A dict mapping full names to python objects. |
reference_resolver
|
An instance of ReferenceResolver. |
Returns | |
|---|---|
| A string containing an index page as Markdown. |