Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

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.


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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-cheader, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-cheader-1.0.0.tar.gz (3.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page