Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change logo href from master_doc back to index #245

Closed
leonarduschen opened this issue Sep 8, 2020 · 1 comment · Fixed by #246
Closed

Change logo href from master_doc back to index #245

leonarduschen opened this issue Sep 8, 2020 · 1 comment · Fixed by #246

Comments

@leonarduschen
Copy link
Contributor

leonarduschen commented Sep 8, 2020

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.

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 in Fairlearn to get their opinion on this fairlearn/fairlearn#570

@leonarduschen
Copy link
Contributor Author

Relevant info documentation sites that are using pydata-sphinx-theme

master_doc is index

Using landing page HTML template (i.e. master_doc is not index)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant