devel/py-argparse-manpage 4.6 DragonFly
Build manual page from python's ArgumentParser object
- System
- DragonFly
- Repository
- DPorts
- Maintainer
- [email protected] (as in FreeBSD)
- License
- APACHE20
- Categories
- devel, python
- Package size
- 42.8 KiB, 200.5 KiB installed
Description
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).
In the other systems
| System | Port | Version |
|---|---|---|
| DragonFly | devel/py-argparse-manpage | 4.6 |
| FreeBSD | devel/py-argparse-manpage | 4.7 |
| NetBSD | devel/py-argparse-manpage | 4.7 |
| HardenedBSD | devel/py-argparse-manpage | 4.7 |
| GhostBSD | devel/py-argparse-manpage | 4.7 |
Install
Binary package:
pkg install py311-argparse-manpage
From DPorts:
cd /usr/dports/devel/py-argparse-manpage && make install clean
Dependencies
Run dependencies 1
No port depends on this one.