Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

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.

Release History

This version
History Node


Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(3.1 kB) Copy SHA256 Hash SHA256
Source None Nov 10, 2014

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers