Switch to pydata sphinx theme #4761
Merged
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.
This PR changes the theme to pydata sphinx theme and also fixes many long standing issues
with the documentation like the search function not working, the non-existance of tables of contents
or adding links to the source code. Some of these fixes are thanks to the theme change,
others are somewhat independent.
Pros of the PR:
This is a particularly important pro because we were not maintaining the theme, so it
progressively broke over time.
sidebar the page level table of contents. Moreover, the left table of contents is foldable,
so with the right reorganization each notebook will have a notebook level table of contents and
a section (examples or tutorials) level toc which is foldable by sections.
Cons/TODOs:
sphinx_panels
version docs are built on -> this is also a pro because couples with cool extension like sphinx
panels means we won't have to care about bootstrap anymore, everything will be updated by these
extensions