skip to navigation
skip to content

sphinxcontrib-cheader 1.0.0

Sphinx c:header directive

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.


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 documentation. The corresponding Sphinx sources can be found at:


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


To enable the extension, edit your Sphinx configuration file to include the extension name in the extensions list; for example:

extensions = ['sphinxcontrib.cheader']


This is free and unencumbered public domain software. For more information, see or the accompanying LICENSE file.

File Type Py Version Uploaded on Size
sphinxcontrib-cheader-1.0.0.tar.gz (md5) Source 2014-11-10 3KB