Skip to main content

Generate man pages for C projects using Doxygen.

Project description

Manos

Manos is a man page generator for C projects that use Doxygen for documentation generation.

Manos does not require any modifications to your project, code comments, or Doxygen configuration file.

Build Status

Why?

Doxygen's man page output (GENERATE_MAN = YES) is less-than-stellar for projects written in the C programming language. For example the formatting and lack of per-function man page is atypical of what one would expect. Manos corrects these shortcomings by generating a man page per-function and with defacto standard formatting.

Installation

Manos requires Python 3.10 or newer and Doxygen 1.9.2 or newer.

Install the project through git checkout or install using your package management tool of choice. In these example pip is used.

$ pip install manos

or from repository checkout:

$ git clone https://github.com/hgs3/manos
$ cd manos
$ pip install .

Usage

Manos can be used from the command-line or as a Python module in code.

After installing Manos, run the following command(s) substituting Doxyfile with the name of your Doxygen configuration file. If successful, there will be a directory created named man with your beautiful man pages.

Command-line Usage

$ manos Doxyfile

Code Usage

import manos
manos.process("path/to/your/Doxyfile")

Documentation

Manos lets you customize the generated output in various ways. The complete list of customization options can be retrieved by running manos -h locally.

Users on *nix systems are encouraged to review the man page for Manos with man manos.

Local Development

If you intend to develop Manos locally, then first install the required development dependencies with:

$ pip install -r requirements.txt

Run unit tests with:

$ pytest

Run type checking with:

$ mypy --strict manos
$ mypy --strict tests

License

Manos is available under the GNU General Public License v3.0.

The project is named after the no-buget horror cult-classic film of the same name.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

manos-0.1.0.tar.gz (60.0 kB view details)

Uploaded Source

Built Distribution

manos-0.1.0-py3-none-any.whl (47.2 kB view details)

Uploaded Python 3

File details

Details for the file manos-0.1.0.tar.gz.

File metadata

  • Download URL: manos-0.1.0.tar.gz
  • Upload date:
  • Size: 60.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for manos-0.1.0.tar.gz
Algorithm Hash digest
SHA256 73e809c338ab6a843fb153c49a7a0642bfc6b61c2d293c789249ab28b79f94d1
MD5 435faf184385ad47b38d8bbafa9098a0
BLAKE2b-256 7d78b19d553e5c3c88a788b95905137895d5fc8f0b27201c0068b6f3eb3777d4

See more details on using hashes here.

File details

Details for the file manos-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: manos-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for manos-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b7f4d75456ee2663282d25456f93eebd5637e027d486fb2ebb008c4ca7cf34c
MD5 3c09eeb41860ae959a6156df01bb2c8d
BLAKE2b-256 a5e6fb016c28c39cbd16976b057acd943b31d4b91400deadc710049e465f3649

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page