matplotlib / matplotlib/mpl-sphinx-theme

Sidebar template for non-core packages

Aperta
#47 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
6
Fork
13
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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?

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia confrontando la navigazione del tema esistente con docs/_templates/mpl_third_party_sidebar.html e con la pagina pytest-mpl renderizzata collegata nell’issue. Conferma se il tema debba fornire questa barra laterale per i pacchetti non core oppure lasciarlo agli overrides; il lavoro è completato quando il comportamento di navigazione concordato è implementato e documentato in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.