search

ipython / traitlets

A lightweight Traits like module
https://traitlets.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
617 stars 201 forks source link

Generate manpage from configuration options #636

Open jasongrout opened 4 years ago

jasongrout commented 4 years ago

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.

SnarkBoojum commented 4 years ago

I don't know anything about traitlets (even though I'm also the one packaging it for Debian!); and not much about manpages : when the need arises, I take an existing manpage and use it as a guide : it's a just a markup language.