pimutils/khal

figure out way to generate doc from cli.py

Open

#154 aperta il 4 feb 2015

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)Python (191 fork)batch import
help wantedtype: enhancement

Metriche repository

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

Descrizione

so I basically want to generate /khal/doc/source/usage.rst from cli.py

Guida contributor

Direzione di ricerca
Esplora cli.py per estrarre comandi e argomenti CLI, quindi utilizza un generatore di documentazione (ad esempio Sphinx autodoc, basato su argparse) per produrre /khal/doc/source/usage.rst.
Tech stack
python
Dominio
cli
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70