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
Release files for linuxdoc 20260504
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| linuxdoc-20260504.tar.gz | 118.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| linuxdoc-20260504-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 186.5 kB
Release files / linuxdoc-20260504.tar.gz
| Download URL | linuxdoc-20260504.tar.gz |
|---|---|
| Size | 118.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe8b7b67c6c728f017f09b8a6c877c3e3ecbc1344e41c44c7c3405c8c01778fc
|
|
BLAKE2b-256 checksum How to use checksums |
c217ef136bcf4645cc79cac1e6a9077ab530831d315e0d11ba3a53adc202121e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.2 cpython/3.14.2 HTTPX/0.28.1
|
Release files / linuxdoc-20260504-py3-none-any.whl
| Download URL | linuxdoc-20260504-py3-none-any.whl |
|---|---|
| Size | 67.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cca33f1499a96ab30fdcab5296bfd28b0ae2371ae56e5dfe929f18b9a7dc7a2f
|
|
BLAKE2b-256 checksum How to use checksums |
95ad793c51946ac0a67d5ae10b4cf7ba1620aaa8488464be97d85ed2e9552eb7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.2 cpython/3.14.2 HTTPX/0.28.1
|
