pimutils/khal

figure out way to generate doc from cli.py

Ouverte

#154 ouverte le 4 févr. 2015

Voir sur GitHubGuide contributeur
 (8 commentaires) (0 réaction) (0 personne assignée)Python (191 forks)batch import
help wantedtype: enhancement

Métriques du dépôt

Stars
 (2 349 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez cli.py pour extraire les commandes et arguments CLI, puis utilisez un générateur de documentation (par exemple Sphinx autodoc, basé sur argparse) pour produire /khal/doc/source/usage.rst.
Stack technique
python
Domaine
cli
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70