lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
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
It would be great if the Read the Docs HTML documentation included buttons to download notebooks (as implemented in the LSDB RTD) and to run the notebooks on Google Colab.
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
Comienza revisando cómo se genera la documentación HTML de Read the Docs en esta plantilla y compárala con la implementación de LSDB RTD mencionada en el issue. Identifica dónde se configuran las páginas de notebooks o los assets y, después, verifica que la documentación generada incluya botones para descargar notebooks y ejecutarlos en Google Colab.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter-notebook
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100