Investigate ReadTheDocs to ease documentation readability
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 16
- Fork
- 15
- Merge medio
- 1g 9h
- PR unite (30g)
- 10
Descrizione
Is there an existing issue for this?
- I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?
This work needs to be approved first.
From a discussion with @dee-ynput and @mkolar it looks like readthedocs (theme and/or platform) might be beneficial for the automated API docs generated through Sphinx.
This could be investigated to assess the benefit/concerns.
How would you imagine the implementation of the feature?
No precise idea yet, it could be simply use the ReadTheDocs theme with sphinx or bringing more in order to get versioning feature automatically there for free.
We need to see if everything can remain on GitHub pages in order to not multiplying the host platforms tho..
Are there any labels you wish to add?
- I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:
No response
Additional context:
No response
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
Non vengono indicati file o test. Inizia esaminando come viene attualmente pubblicata su GitHub Pages la documentazione API generata da Sphinx, quindi analizza il tema e la piattaforma ReadTheDocs, comprese le considerazioni relative a versioning e hosting; il lavoro è completo quando sono documentati i vantaggi, le criticità e una raccomandazione per l’approvazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100