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 (191 forks)batch import
help wantedtype: enhancement

Repository metrics

Stars
 (2,349 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

Contributor guide

Research direction
Explore cli.py to extract CLI commands and arguments, then use a documentation generator (e.g., Sphinx autodoc, argparse based) to produce /khal/doc/source/usage.rst.
Tech stack
python
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70