github_docs_index.index_generator module¶
-
class
github_docs_index.index_generator.
GithubDocsIndexGenerator
(config)[source]¶ Bases:
object
-
generate_index
(additional_links=[])[source]¶ Main entry point to query GitHub, retrieve repository information, generate the index document and return rST.
Parameters: additional_links ( list
ofIndexLink
) – Optional list of additionalIndexLink
instances to include in the documentation index.Returns: generated rST index document
-