search

pradyunsg / furo

A clean customizable documentation theme for Sphinx
https://pradyunsg.me/furo/quickstart
MIT License
2.76k stars 317 forks source link

Add a link for genindex on the sidebar #396

Closed cursorius-cursor closed 2 years ago

cursorius-cursor commented 2 years ago

As a standard, getting the genindex is placed on the bottom of the top index page. I like to have a link to the genindex on all pages and include it at the bottom of the sidebar. Would be nice, if you like the Idea too. :-) I missed to find out how to use the translation for unsing genindex, as an example I used the german translation.

pradyunsg commented 2 years ago

Hi there! Thanks for this PR!

If you want to include the genindex page in the sidebar, you can include it in the sidebar by including genindex in the toctree. I don't think injecting HTML for that page across all pages -- especially as part of scroll-end -- is the right thing to do.