A sphinx autodoc extension for c modules
Project description
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_function
With 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx_c_autodoc-1.2.2.tar.gz
(31.7 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_c_autodoc-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1864705108874d10e547c4aae34b33b9b5e49ae8f2c0ac53d76a1774fa7818f2 |
|
MD5 | 8fba0b2862f8d426bc5010d54f42bf01 |
|
BLAKE2b-256 | a4e292a7b90bb8f0f74e2b3ec1914560ed921270b7887cd762fab92381e11672 |