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
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 sphinx_c_autodoc-1.7.0.tar.gz.
File metadata
- Download URL: sphinx_c_autodoc-1.7.0.tar.gz
- Upload date:
- Size: 32.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e2e4d2014816ca99278b0a827e31144b62e5bb9fa4ac9b53635bf1fe50c6863c
|
|
| MD5 |
0acf5ac510b187f8da04e7d052eac5ce
|
|
| BLAKE2b-256 |
6bc13246a8e43c2915b4e732ab2c80995d4a7fdc62d962121424a9e50ac0ecb3
|
Provenance
The following attestation bundles were made for sphinx_c_autodoc-1.7.0.tar.gz:
Publisher:
release.yml on speedyleion/sphinx-c-autodoc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_c_autodoc-1.7.0.tar.gz -
Subject digest:
e2e4d2014816ca99278b0a827e31144b62e5bb9fa4ac9b53635bf1fe50c6863c - Sigstore transparency entry: 2387819988
- Sigstore integration time:
-
Permalink:
speedyleion/sphinx-c-autodoc@763aefdd644be1949d69703d13548e02c9421867 -
Branch / Tag:
refs/tags/v1.7.0 - Owner: https://github.com/speedyleion
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@763aefdd644be1949d69703d13548e02c9421867 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_c_autodoc-1.7.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_c_autodoc-1.7.0-py3-none-any.whl
- Upload date:
- Size: 35.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d0b5a6d6d1658509dbe04dee99654847cd15333db786661ae179f80b0d791ce
|
|
| MD5 |
b37928bff96e974d9131d6edd213e0d6
|
|
| BLAKE2b-256 |
45f39c476b23b74d8d150fe3ba7d39f5303405a836e1cf8327faeade301c963d
|
Provenance
The following attestation bundles were made for sphinx_c_autodoc-1.7.0-py3-none-any.whl:
Publisher:
release.yml on speedyleion/sphinx-c-autodoc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_c_autodoc-1.7.0-py3-none-any.whl -
Subject digest:
6d0b5a6d6d1658509dbe04dee99654847cd15333db786661ae179f80b0d791ce - Sigstore transparency entry: 2387819996
- Sigstore integration time:
-
Permalink:
speedyleion/sphinx-c-autodoc@763aefdd644be1949d69703d13548e02c9421867 -
Branch / Tag:
refs/tags/v1.7.0 - Owner: https://github.com/speedyleion
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@763aefdd644be1949d69703d13548e02c9421867 -
Trigger Event:
push
-
Statement type:
