guyzmo/git-repo

Write more thorough documentation

Aperta

#146 aperta il 21 mar 2017

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

Metriche repository

Star
 (854 stelle)
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
Impara lo strumento di documentazione Sphinx, esplora la struttura del progetto e inizia a scrivere la documentazione per l'uso e gli interni, quindi caricala su ReadTheDocs.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75