Publish documentation using Sphinx
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
La issue menziona Sphinx e rimanda a una guida alla documentazione Python, ma non contiene file del repository, test o punti di ingresso della documentazione. Esamina prima la struttura della documentazione esistente e la guida collegata; il lavoro è completato quando la documentazione del progetto è configurata e pubblicata usando Sphinx.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
While looking at #33 that seemed like the simplest approach / lowest hanging fruit and exciting to publish docs with, the better documentation publishing for Python is Sphinx.
Let's therefore use Sphinx instead following this - http://docs.python-guide.org/en/latest/writing/documentation/
- Lingua principale
- Python
- Stelle
- 19
- Fork
- 20
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
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.
Altre issue di CodeForAfrica/HealthTools.API
-
Is it up?Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
CodeForAfrica/HealthTools.API#138 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
CodeForAfrica/HealthTools.API#136 ·
-
Update test scriptsAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Upgrade runtime to Python3Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 45/100
Tutte le issue di CodeForAfrica/HealthTools.API
Issue simili
-
Broken links found in docsApertadocs pydanty:is-working
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
pydantic/pydantic-ai#10113 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
GreedyBear-Project/GreedyBear#1727 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
ARM-software/CMSIS-DSP#354 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
kiat/codeAssist#391 ·
-
needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
darnitdevorg/darnit#587 ·
I maintainer di solito rispondono entro 1 giorno