pimutils/khal

figure out way to generate doc from cli.py

Offen

#154 geöffnet am 04.02.2015

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (191 Forks)batch import
help wantedtype: enhancement

Repository-Metriken

Stars
 (2.349 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche cli.py, um CLI Befehle und Argumente zu extrahieren, und verwende dann einen Dokumentationsgenerator (z. B. Sphinx autodoc, argparse basiert), um /khal/doc/source/usage.rst zu erstellen.
Tech Stack
python
Domain
cli
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70