matplotlib / matplotlib/mpl-sphinx-theme
Sidebar template for non-core packages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
The top nav bar is hardcoded into the theme, which works well for `matplotlib/matplotlib`. However, for non-core packages there is no site-wide top level navigation. For `matplotlib/pytest-mpl` I've created a new sidebar template for the top level navigation: https://github.com/matplotlib/pytest-mpl/blob/main/docs/_templates/mpl_third_party_sidebar.html. This sidebar is set to appear above any existing "Section Navigation" sidebars on all pages. https://matplotlib.org/pytest-mpl/latest/index.html
Is this something that should be included in this theme so other non-core packages can have a consistent design? Or maybe you'd rather non-core packages just override the nav bar?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the existing theme navigation with docs/_templates/mpl_third_party_sidebar.html and the rendered pytest-mpl page linked in the issue. Confirm whether the theme should provide this sidebar for non-core packages or leave it to overrides; done means the agreed navigation behavior is implemented consistently and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100