ipython / ipython/traitlets

Generate manpage from configuration options

Open
#636 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

In https://github.com/jupyter/jupyter_server/issues/320, @SnarkBoojum submitted a manpage for Jupyter Server that largely encoded the results from `--help`. We realized that it would make more sense to have an automatically generated manpage at the traitlet level from the configurable traits. This issue is about adding a `--generate-manpage` option, or perhaps a separate manpage generation command, that does something similar to `-h`, but generates the output as a manpage.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.