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

feat: add the indices to the optional sidebar components #922

Merged
merged 5 commits into from Sep 20, 2022

Conversation

12rambau
Copy link
Collaborator

@12rambau 12rambau commented Sep 8, 2022

Fix #316

It has been requested a long time ago but better late than sorry ;-)

So I created a small indices.html and the according _indices.scss. It is build to be added in the left_sidebar_end:

"left_sidebar_end": ["indices.html", "sidebar-ethical-ads.html"]

I decided not to add it in our default documentation, maybe we should ? In the meantime here are 2 screenshot from one of my documentation:

Capture d’écran 2022-09-08 à 19 46 14

Capture d’écran 2022-09-08 à 19 46 04

@12rambau 12rambau marked this pull request as ready for review September 8, 2022 17:55
@12rambau 12rambau changed the title feat: add the indices to the optional sidebar component feat: add the indices to the optional sidebar components Sep 8, 2022
Copy link
Collaborator

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me - my one suggestion is that we document this so that it's a bit more discoverable. Maybe we could add a section to Navigation and links to note how to add indices to the sidebar?

@12rambau
Copy link
Collaborator Author

@choldgraf I added the requested extra page. There is now a warning in the build (I think it's unrelated to my modification) but I didn't find where the transform member is called. Do you have an idea ?

docs/user_guide/indices.rst Outdated Show resolved Hide resolved
@12rambau 12rambau merged commit 28fef37 into pydata:main Sep 20, 2022
@12rambau 12rambau deleted the genindex branch September 20, 2022 19:08
@jarrodmillman jarrodmillman added this to the 0.11 milestone Sep 21, 2022
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 this pull request may close these issues.

Expose the genindex index
4 participants