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.0.tar.gz
(31.4 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_c_autodoc-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4e9fb491aa07973055a47bbade0dbc15ee719c21206290646fee6193aa25177 |
|
MD5 | cd66f802a8c380a6c4e10a261f76da07 |
|
BLAKE2b-256 | 00d6ffa86b8cf99b3b266494c410433e1e2bd2975d5db9979ae937d6b1dd02ff |