lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jinja
- Stelle
- 85
- Fork
- 16
- Merge medio
- 6h 18m
- PR unite (30g)
- 1
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando come viene prodotta la documentazione HTML di Read the Docs in questo template e confrontala con l’implementazione di LSDB RTD menzionata nell’issue. Individua dove vengono configurate le pagine dei notebook o gli asset, quindi verifica che la documentazione generata includa pulsanti per scaricare i notebook ed eseguirli su Google Colab.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- jupyter-notebook
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100