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.
linuxdoc is distributed under the terms of the AGPL-3.0-or-later license.
Install
Install LinuxDoc release from pypi using pip:
python -m pip install --user -U linuxdoc
Development
This project is managed by hatch, for development tasks you should install hatch:
pipx install hatchThe tools required for the developer environment are provided in the mise.toml configuration file (Mise En Place).
git clone https://github.com/return42/linuxdoc.git
cd linuxdoc
mise installFormat and lint your code before commit:
hatch run fix
hatch run checkTo enter the development environment use shell dev:
hatch shell dev
# source "/share/linuxdoc/.venv/bin/activate"
# (.venv) $To get a live build of documentation:
hatch run doc:man
hatch run doc:liveFor project tasks & maintenance use:
hatch run prj --helpBuild & Deploy
To force push online doc to the gh-pages branch:
hatch run doc:man
hatch run ./prj doc.gh-pagesUse hatch build command to build sdist an wheel:
hatch build -cand hatch publish command to deploy on pypi (or test.pypi.org):
hatch publish -r https://test.pypi.org/legacy/ ./dist/linuxdoc-YYYYMMDD*
hatch publish ./dist/linuxdoc-YYYYMMDD*Mise En Place
For the developer environment, mise en place is recommended:
$ curl https://mise.run | sh
# to install shell completions .. and mises's backends dependencies
$ mise use -g usageTo activate mise in the current bash session see mise activate --help. For a more streamlined setup, you can configure activation in your shell’s configuration file.
For the Bash shell, the following lines can be added to the ~/.bashrc file:
if [ -f "${HOME}/.local/bin/mise" ]; then
eval "$("${HOME}/.local/bin/mise" activate bash --shims)"
fiReferences
Documentation: https://return42.github.io/linuxdoc
Releases: https://pypi.org/project/linuxdoc/
Issue tracker: https://github.com/return42/linuxdoc/issues
License file: AGPLv3+
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file linuxdoc-20260504.tar.gz.
File metadata
- Download URL: linuxdoc-20260504.tar.gz
- Upload date:
- Size: 118.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
Hatch/1.16.2 cpython/3.14.2 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe8b7b67c6c728f017f09b8a6c877c3e3ecbc1344e41c44c7c3405c8c01778fc
|
|
| MD5 |
2a3e23c7ef5c15ce5b061ba554918e89
|
|
| BLAKE2b-256 |
c217ef136bcf4645cc79cac1e6a9077ab530831d315e0d11ba3a53adc202121e
|
File details
Details for the file linuxdoc-20260504-py3-none-any.whl.
File metadata
- Download URL: linuxdoc-20260504-py3-none-any.whl
- Upload date:
- Size: 67.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
Hatch/1.16.2 cpython/3.14.2 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cca33f1499a96ab30fdcab5296bfd28b0ae2371ae56e5dfe929f18b9a7dc7a2f
|
|
| MD5 |
cc78aa5a8d5ce216320d900407c426f6
|
|
| BLAKE2b-256 |
95ad793c51946ac0a67d5ae10b4cf7ba1620aaa8488464be97d85ed2e9552eb7
|
