Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Publish documentation using Sphinx

Aperta
#39 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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

enhancement help wanted

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

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CodeForAfrica/HealthTools.API

Tutte le issue di CodeForAfrica/HealthTools.API

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.