lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
Personne n'a encore pris cette issue.
- Langage dominant
- Jinja
- Étoiles
- 85
- Forks
- 16
- Merge moyen
- 6 h 18 min
- PR mergées (30 j)
- 1
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner comment la documentation HTML de Read the Docs est produite dans ce template et comparez-la à l’implémentation de LSDB RTD mentionnée dans l’issue. Identifiez où les pages de notebooks ou les assets sont configurés, puis vérifiez que la documentation générée inclut des boutons permettant de télécharger les notebooks et de les exécuter dans Google Colab.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- jupyter-notebook
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100