argparse-manpage

build manual page from python's ArgumentParser object

WWW CVSWeb GITHub
  1. Package version
    argparse-manpage-4.3
  2. Maintainer
    The OpenBSD ports mailing-list

ArgumentParser instance -> manual page.

Avoid documenting your Python script arguments on two places!
This is typically done in an argparse.ArgumentParser help configuration
(help=, description=, etc.), and also in a manually crafted manual page.

The good thing about an ArgumentParser objects is that it actually provides a
traversable "tree-like" structure, with all the necessary info needed to
automatically generate documentation, for example in a groff typesetting system
(manual pages).
And this is where this project can help.

There are two supported ways to generate the manual, either script it using the
installed command argparse-manpage, or via setup.py build automation (with a
slight bonus of automatic manual page installation with setup.py install).

  • lang/python/3.10
  • devel/py-build,python3
  • devel/py-installer,python3
  • devel/py-setuptools,python3
  • devel/py-wheel,python3

  • lang/python/3.10