You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm very new to using Sphinx documentation but as far as I know, there are generally 2 different ways to generate the index.html for Sphinx documentation landing page.
Directly from index.rst - which is the more common and straightforward way. In this case, master_doc is set as index in conf.py
Using a custom HTML template by adding html_additional_pages = {'index': '<template>.html'} in conf.py. In this case, master_doc is not index, but rather just whatever RST file containing the toctree root.
I'm very new to using Sphinx documentation but as far as I know, there are generally 2 different ways to generate the
index.html
for Sphinx documentation landing page.index.rst
- which is the more common and straightforward way. In this case,master_doc
is set asindex
inconf.py
html_additional_pages = {'index': '<template>.html'}
inconf.py
. In this case,master_doc
is notindex
, but rather just whatever RST file containing the toctree root.This creates 2 different logo-click behavior between documentation sites that use the former method (e.g. https://pydata-sphinx-theme.readthedocs.io/en/latest/) and documentation sites that use the later (e.g. https://numpy.org/devdocs/).
One project that would benefit from this change is NumPy as mentioned in this issue numpy/numpy#17211
Edit: Since
Fairlearn
documentation will also be affected, I have created an issue inFairlearn
to get their opinion on this fairlearn/fairlearn#570The text was updated successfully, but these errors were encountered: