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

🔍 Show more levels for the in-page table of contents #36

Merged
merged 4 commits into from
Aug 14, 2022

Conversation

weiji14
Copy link
Owner

@weiji14 weiji14 commented Aug 14, 2022

Making it easier to navigate to the desired subsection on https://zen3geo.readthedocs.io/en/v0.2.0/api.html. Also a few minor tweaks here are there.

Preview at https://zen3geo--36.org.readthedocs.build/en/36/api.html

Before After
image image

References:

Make it easier to jump to the relevant sections, since the list of DataPipes is increasing!
Swapping positions of Pyogrio and Rioxarray datapipes.
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Aug 14, 2022
@weiji14 weiji14 added this to the 0.3.0 milestone Aug 14, 2022
@weiji14 weiji14 self-assigned this Aug 14, 2022
Found the right sphinx-book-theme config setting to increase the depth of the secondary sidebar (on the right) from 2 to 3. See https://sphinx-book-theme.readthedocs.io/en/stable/customize/sidebar-secondary.html. Decided too that the in-page table of contents can go.
@weiji14 weiji14 changed the title 🔍 Add table of contents to top of API reference page 🔍 Show more levels for the in-page table of contents Aug 14, 2022
@weiji14 weiji14 marked this pull request as ready for review August 14, 2022 20:52
@weiji14 weiji14 merged commit 62b86a9 into main Aug 14, 2022
@weiji14 weiji14 deleted the doc/api-reorganize branch August 14, 2022 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant