matplotlib / matplotlib/mpl-sphinx-theme
Sidebar template for non-core packages
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 6
- Forks
- 13
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Vergleich der bestehenden Themennavigation mit docs/_templates/mpl_third_party_sidebar.html und der im Issue verlinkten gerenderten pytest-mpl-Seite. Bestätige, ob das Theme diese Sidebar für Pakete außerhalb des Kerns bereitstellen sollte oder ob dies Overrides überlassen werden soll; abgeschlossen ist die Aufgabe, wenn das vereinbarte Navigationsverhalten konsistent implementiert und dokumentiert ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100