github_docs_index.index_document module

class github_docs_index.index_document.IndexDocument(config)

Bases: object

Class to represent the actual index document

add_indexlinks(links)

doc_template = '\n.. _top:\n\n{title}\n\n< `Chronological Index <#chrono>`_ | `Alphabetical Index <#alpha>`_ >\n\n.. _quicklinks:\n\nQuick Links\n-----------\n\n{quicklinks}\n\n< `top. <#top>`_ | `Quick Links <#quicklinks>`_ | `Alphabetical Index <#alpha>`_ >\n\n.. _chrono:\n\nChronological Index (most recently updated first)\n-------------------------------------------------\n\n{chrono}\n\n< `top. <#top>`_ | `Quick Links <#quicklinks>`_ | `Chronological Index <#chrono>`_ >\n\n.. _alpha:\n\nAlphabetical Index\n------------------\n\n{alpha}\n\n< `top. <#top>`_ | `Quick Links <#quicklinks>`_ | `Chronological Index <#chrono>`_ | `Alphabetical Index <#alpha>`_ >\n{footer}\n'

generate_rst()