BSD Ports

textproc/argparse-manpage 4.6p0 OpenBSD

build manual page from python's ArgumentParser object

System
OpenBSD
Repository
OpenBSD ports
Maintainer
The OpenBSD ports mailing-list <[email protected]>
Categories
textproc, lang/python

Description

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).

Install

Binary package:

pkg_add argparse-manpage

From the ports tree:

cd /usr/ports/textproc/argparse-manpage && make install

Dependencies

Build dependencies 5
Run dependencies 1
Required by 1