warnings building the man page
Open
Nobody has claimed this yet.
type: bug
type: documentation
- Dominant language
- Python
- Stars
- 3.1k
- Forks
- 233
- Avg merge
- 1h 44m
- Merged PRs (30d)
- 1
Description
When building the man page for 0.9.8, I see:
checking consistency... .../khal-0.9.8/doc/source/man.rst: WARNING: document isn't included in any toctree
done
writing... khal.1 { usage configure standards faq license } .../khal-0.9.8/doc/source/usage.rst:48: WARNING: unknown option: --color
.../khal-0.9.8/doc/source/usage.rst:48: WARNING: unknown option: --color
.../khal-0.9.8/doc/source/usage.rst:371: WARNING: unknown option: --interactive
.../khal-0.9.8/doc/source/configure.rst:16: WARNING: unknown option: -c path/to/config
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by building the man page from doc/source/man.rst and inspect the referenced entries in doc/source/usage.rst and doc/source/configure.rst. Address the toctree warning and the unknown-option warnings for --color, --interactive, and -c path/to/config, then rebuild the man page to confirm the warnings are gone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100