A sphinx autodoc extension for c modules
Project description
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:
.. c:function:: int my_adding_function(int a, int b) 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`
Requires
Similar Tools
Full Documentation
The complete documentation can be found at https://sphinx-c-autodoc.readthedocs.io/en/latest
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size sphinx_c_autodoc-0.4.0-py3-none-any.whl (34.7 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size sphinx-c-autodoc-0.4.0.tar.gz (30.7 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for sphinx_c_autodoc-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69181d6f04853bb2988402d3807e0b31bce15f285e8ccc0c2aea2609b45c4086 |
|
MD5 | 2fc8b3d37e195ecc3572f44a77b82264 |
|
BLAKE2-256 | d807d8bdd8351bb1f2494275d581b99adb47f3b831582bfe39de007fc01f8347 |