Sphinx c:header directive
Project description
This is a Sphinx extension that implements the c:header directive that is inadvertently absent from Sphinx’s built-in C domain. It works similarly to the built-in py:module directive.
Examples
At the beginning of the description of a header file in your documentation, insert a corresponding c:header directive as follows:
.. c:header:: <libfoobar.h>
The aforementioned creates an index entry of: libfoobar.h (C header).
For a real usage example, see the http://libcpr.org documentation. The corresponding Sphinx sources can be found at: https://github.com/dryproject/libcpr/tree/master/doc/manual
Installation
Refer to the PyPI Tutorial for installation instructions. If you have a modern Python environment, installation should be as easy as:
$ sudo pip install sphinxcontrib-cheader
Configuration
To enable the extension, edit your Sphinx conf.py configuration file to include the extension name in the extensions list; for example:
extensions = ['sphinxcontrib.cheader']
License
This is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying LICENSE file.
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
Hashes for sphinxcontrib-cheader-1.0.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1690019d40f74e3de250ae3bc0f6beec2d3c870c648d1b8bdb6c8aab56ef40ac |
|
| MD5 | 00acc78d02115bfe11cc686fde94b99d |
|
| BLAKE2b-256 | 02c8ca56402f5e3eb7744c87d9ad502f929948db0cb0728ff2d33c33640bac2c |
