help2man 0.0.1

Convert --help and --version to man page.

help2man

Convert --help and --version to man page.

This a python version of GNU help2man. It solves the following problems[^email]

GNU help2man cannot convert argparse correctly

Because argparse outputs:

usage: help2man [-h] ...
                executable ...

Convert --help and --version to man page.

positional arguments:
  executable            executable program name
  ...

options:
  -h                    show this help message and exit
  ...

help2man will ignore positional arguments: and options: because it only detect Options:. And it only detect first line as synopsis and detect other lines as description incorrectly.

GNU help2man cannot customize template

I provide help2man --template XXX and help2man --template-file XXX to do it. The template language is jinja2. See template.man and template.md as examples.

GNU help2man don't provide any programming API

Now you can use it in python. If you want to generate man pages automatically when you build a python project, you can see setuptools-generate:

See document to know more.

[^email]: I send email to the author of GNU help2man but got no response since now.