guyzmo/git-repo

Write more thorough documentation

Open

#146 aperta il 21 mar 2017

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (86 fork)batch import
enhancementgood first issuehelp wanted

Metriche repository

Star
 (837 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

Guida contributor

Direzione di ricerca
Configura la struttura della documentazione Sphinx nel progetto, crea un manuale d'uso appropriato e una pagina man, documenta gli interni e configura l'integrazione con Read the Docs. Fai riferimento alla struttura e al contenuto della documentazione di progetti Python simili.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70