The LinuxDoc library contains Sphinx-doc extensions and command line tools to extract documentation from C/C++ source file comments. Even if this project started in context of the Linux-Kernel documentation, you can use these extensions in common Sphinx-doc projects.
Install LinuxDoc using pip:
pip install --user -U linuxdoc
This project is managed by hatch, for development
tasks you should install hatch:
$ pipx install hatch
Format and lint your code before commit:
$ hatch run fix $ hatch run check
To enter the development environment use shell:
$ hatch shell
For project tasks & maintenance use:
$ hatch run prj
For example, to get a live build of documentation:
$ hatch run prj doc.live
- Documentation: https://return42.github.io/linuxdoc
- Releases: https://pypi.org/project/linuxdoc/
- Code: https://github.com/return42/linuxdoc
- Issue tracker: https://github.com/return42/linuxdoc/issues
- License: AGPLv3+
