[Python-ideas] Enabling man page structure for python

Mike Graham mikegraham at gmail.com
Thu Oct 25 17:09:35 CEST 2012


On Thu, Oct 25, 2012 at 10:48 AM, Mark Hackett
<mark.hackett at metoffice.gov.uk> wrote:
> Because it requires a programmed man page creation, Sphinx, pydoc et al
> haven't been really of any use, since they are YAML (Yet Another Markup
> Language) as far as I've been able to tell, not really able to allow runtime
> changes to reflect in document generation. I may have missed how, however...

Use sphinx.builders.manpage.ManualPageBuilder to make a manpage with
sphinx. I wouldn't be shocked if other documentation systems had
something similar.

I wouldn't be opposed to having argparse have some builtin or
third-party capability for generating manpages. I wouldn't use getopt
myself for anything but mimicing old, established, getopt-based
interfaces. argparse has a lot more functionality already and it's
more reasonable to expand it since it's a Python thing, not a
pre-established thing.

Mike



More information about the Python-ideas mailing list