matplotlib / matplotlib/mpl-sphinx-theme
Sidebar template for non-core packages
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 6
- Forks
- 13
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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?
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza comparando la navegación existente del tema con docs/_templates/mpl_third_party_sidebar.html y con la página pytest-mpl renderizada enlazada en el issue. Confirma si el tema debe proporcionar esta barra lateral para paquetes que no forman parte del núcleo o dejarlo en manos de los overrides; se considera terminado cuando el comportamiento de navegación acordado esté implementado y documentado de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 30/100