Changing landing page#
It is possible to have a custom landing page in Sphinx documentation. This is achieved by adding a custom template file for that page and setting html_additional_pages in conf.py.
templates_path = ["_templates"]
html_additional_pages = {
"index": "your-custom-landing-page.html"
}
Note
You’ll need to write HTML for the page in _templates/your-custom-landing-page.html, if you use the above example as-is. Meanwhile, set master_doc configuration or root_doc configuration in conf.py to content or other file name for documentation root page. See Demo for example.