pimutils/khal

figure out way to generate doc from cli.py

Open

#154 opened on Feb 4, 2015

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Python (2,349 stars) (191 forks)batch import
help wantedtype: enhancement

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
PythonCLI framework (click/argparse)Sphinx documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how to generate reStructuredText documentation from the CLI code in cli.py. Look into tools like sphinx click or sphinx argparse that automatically generate docs from Click or argparse command definitions. Examine the existing usage.rst file in /khal/doc/source/ to understand the current format. Consider if a custom script is needed or if an existing tool can be integrated into the build process.