lincc-frameworks / lincc-frameworks/python-project-template
Cleaner left-hand table-of-contents for API reference
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jinja
- Estrellas
- 85
- Forks
- 16
- Merge medio
- 6 h 18 min
- PR fusionados (30 d)
- 1
Descripción
Looking at the HATS RTD, the menu options in the left-hand-side for the API reference have a lot of unnecessary duplication:
API reference
└── hats
├── hats.catalog
├── hats.inspection
└── ...
I would really love if we could have it be simpler:
hats API reference
├── catalog
├── inspection
└── ...
this includes the package name in the top-level, and omits the package name from the submodule names.
I don't even know if sphinx/autoapi supports this, but I can dream, right?
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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
Empieza por localizar la configuración de Sphinx/AutoAPI que genera la referencia de API en la documentación de Read the Docs. Comprueba si sus opciones pueden producir el nombre solicitado para el paquete de nivel superior y etiquetas más cortas para los submódulos. Se considera terminado cuando la navegación izquierda renderizada muestra “hats API reference” con entradas como “catalog” e “inspection”, sin repetir los nombres de los paquetes.
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
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100