linuxdoc

library20260504pypypiunverified

Sphinx-doc extensions and tools to extract documentation from C/C++ source file comments, including kernel-doc support. Current version 20240924. Released as needed, no fixed cadence.

devops

pip install linuxdoc

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · LINUXDOC

linuxdoc

devopspythonv20260504

Install

5.8s avg

Import

—

Disk

99MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v20260504 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.9MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.8s · import 0.000s · 93MB

99MB installed

● package 99MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

KernelDocDirective

✓ from linuxdoc import KernelDocDirective

✗ from linuxdoc.kernel_doc import KernelDocDirective

Minimal conf.py setup to enable linuxdoc extension and kernel-doc directive.

# conf.py from linuxdoc import linuxdoc_extension extensions = ['linuxdoc.linuxdoc_extension'] # Also register kernel-doc directive from linuxdoc.kernel_doc import KernelDocDirective def setup(app): app.add_directive('kernel-doc', KernelDocDirective)

linuxdoc --version

Debug

Known issues

gotchaAs of version 20240924, the import path for KernelDocDirective is `linuxdoc.kernel_doc.KernelDocDirective`; importing from top-level `linuxdoc.KernelDocDirective` fails.

fix

Use `from linuxdoc.kernel_doc import KernelDocDirective`.

affects: >=2024

gotchaThe extension is meant for C/C++ kernel-doc comments; it may not work with other comment styles.

fix

Ensure source files use kernel-doc style comments (e.g., /** ... */).

affects: all

gotchaLinuxdoc requires Sphinx; incompatible Sphinx versions may cause failures. Check compatibility with your Sphinx version.

fix

Use Sphinx version that matches linuxdoc's requirements (see setup.py/requirements).

affects: all

Upgrade

Version history

20260504latest on PyPI · released May 4, 2026

Audit

Dependencies

sphinxrequiredRequired for building documentation with Sphinx extensions.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/return42/linuxdoc ↗

packagehttps://pypi.org/project/linuxdoc/ ↗

docshttps://return42.github.io/linuxdoc ↗