Skip to content

StarfishStorage/argparse-manpager

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Argparse - Manpager

Generate manual pages from executable python modules using argparse.

Installation

Archlinux users have a package in the AUR. To use the PKGBUILD as it is kept in this repository, the makepkg-template for git has to be installed.

This project uses waf to compile and install. If you already have waf installed with your distribution, you can just waf configure install. If you do not have waf installed, execute

wget -O waf http://ftp.waf.io/pub/release/waf-1.8.6
chmod 755 waf
./waf configure install

Usage

For example, this generates the manpage for a module already built into python.

manpager http.server

For more options, consult the manpager manpage.

With waf

This project also installs a waf tool for use in your own projects. It can be used to install whole python packages, generate starter scripts and manual pages to let it look like an ordinary binary. The wscript of this project itself can be used as a simple example. The docstring of the tool provides more detailed documentation.

About

generate manual pages from python argparse desriptions

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.1%
  • Shell 1.9%