DOC: collapse subpages in sidebar for API reference docs #40761
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks like this speeds up to build from 75m to 35m. Having the dropdowns is nice, but I think this makes sense. |
Closed
|
thanks @jorisvandenbossche |
|
@meeseeksdev backport 1.2.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/pandas
that referenced
this pull request
Apr 13, 2021
…PI reference docs
|
Something went wrong ... Please have a look at my logs. |
simonjayhawkins
pushed a commit
that referenced
this pull request
Apr 13, 2021
…ce docs (#40922) Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
This was referenced Apr 14, 2021
JulianWgs
pushed a commit
to JulianWgs/pandas
that referenced
this pull request
Jul 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The latest version of the theme added the capability to collapse/expand subsections in the sidebar (without directly navigating to the page), see eg the new dropdown arrows on https://pandas.pydata.org/docs/dev/getting_started/index.html
But, an unintended consequence is that the build takesmuch longer (this the reason that the Web / Doc CI build is now always slow on the current open PRs), and this is especially due to our API reference page, which has more than 1000 subpages, and all those pages now have the full navigation structure to all other 1000 pages.
In this PR I am trying to override the base theme template for the sidebar navigation, to not do this for the reference section of our docs.
xref pydata/pydata-sphinx-theme#364