Skip to main content

A script to generate Sphinx ReST from Doxygen XML

Project description


Sphinxygen is a Python module/script that generates Sphinx markup to describe a C API, from an XML description extracted by Doxygen.


Sphinxygen can be installed from PyPI with pip:

pip3 install sphinxygen

Alternatively, it can be installed locally from this source tree:

pip3 install .


Sphinxygen is mainly intended for use on the command line or in scripts. After installation, sphinxygen should be available to be run on an index.xml file, for example:

sphinxygen xml/index.xml sphinx_input

See the output of sphinxygen --help for details.

A sphinxygen module is also installed for programmatic use within Python, typically via which is a straightforward reflection of the command-line options. The command-line interface is also available as sphinxygen.main().

A minimal meson build definition is included for using Sphinxygen as a subproject. It is not intended for installation, or any use other than wrapping to ensure that it's available from meson.

-- David Robillard

Project details

Download files

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

Source Distribution

sphinxygen-1.0.4.tar.gz (13.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page