sphinx-c-autodoc
Dual-licensed under MIT or the UNLICENSE.
A basic attempt at extending Sphinx and autodoc to work with C files.
The idea is to add support for similar directives that autodoc provides. i.e.
A function in my_c_file.c:
/**
* A simple function that adds.
*
* @param a: The initial value
* @param b: The value to add to `a`
*
* @returns The sum of `a` and `b`.
*
*/
int my_adding_function(int a, int b) {
return a + b;
}Could be referenced in documentation as:
.. autocfunction:: my_c_file.c::my_adding_functionWith the resulting documentation output of:
- int my_adding_function(int a, int b)
A simple function that adds.
- Parameters:
a - The initial value
b - The value to add to a
- Returns:
The sum of a and b
Requires
Similar Tools
Full Documentation
The complete documentation can be found at https://sphinx-c-autodoc.readthedocs.io/en/latest
1 maintainer
Metadata
1 maintainer
Release files for sphinx-c-autodoc 1.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_c_autodoc-1.8.0.tar.gz | 32.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_c_autodoc-1.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.8 kB
Release files / sphinx_c_autodoc-1.8.0.tar.gz
| Download URL | sphinx_c_autodoc-1.8.0.tar.gz |
|---|---|
| Size | 32.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
abcd27b59d425d21c50815c8647ab0ce852608fd41f8bac28a84b603d3a53118
|
|
BLAKE2b-256 checksum How to use checksums |
5777a618dfe5c4ace722a01f3ef1662241142c4ac4dbdf086adb43c48908ce7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency logRelease files / sphinx_c_autodoc-1.8.0-py3-none-any.whl
| Download URL | sphinx_c_autodoc-1.8.0-py3-none-any.whl |
|---|---|
| Size | 35.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c7633e4add02911ded9f43bd46c681579d77c002303fa5c9a9333921d17e82e
|
|
BLAKE2b-256 checksum How to use checksums |
539be52c5cff051f0f1a713015beb2914d8c2b4b86ab676ec38946d4c2d06e65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency log
