sphinxcontrib-cheader
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-cheader 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinxcontrib-cheader-1.0.0.tar.gz | 3.1 kB | Without provenance | Details |
Release files / sphinxcontrib-cheader-1.0.0.tar.gz
| Download URL | sphinxcontrib-cheader-1.0.0.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1690019d40f74e3de250ae3bc0f6beec2d3c870c648d1b8bdb6c8aab56ef40ac
|
|
BLAKE2b-256 checksum How to use checksums |
02c8ca56402f5e3eb7744c87d9ad502f929948db0cb0728ff2d33c33640bac2c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-cheader 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
