lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jinja
- Sterne
- 85
- Forks
- 16
- Ø Merge
- 6 Std. 18 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, zu prüfen, wie die Read the Docs HTML-Dokumentation in diesem Template erzeugt wird, und vergleiche dies mit der im Issue erwähnten LSDB RTD-Implementierung. Ermittle, wo Notebook-Seiten oder Assets konfiguriert werden, und überprüfe anschließend, dass die generierte Dokumentation Buttons zum Herunterladen von Notebooks und zum Ausführen in Google Colab enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100