Skip to main content

A script to generate Sphinx ReST from Doxygen XML

Project description

Sphinxygen

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

Installation

Sphinxygen can be installed from PyPI with pip:

pip3 install sphinxygen

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

pip3 install .

Usage

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 sphinxygen.run() 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 sphinxygen.py to ensure that it's available from meson.

-- David Robillard d@drobilla.net

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 details)

Uploaded Source

File details

Details for the file sphinxygen-1.0.4.tar.gz.

File metadata

  • Download URL: sphinxygen-1.0.4.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for sphinxygen-1.0.4.tar.gz
Algorithm Hash digest
SHA256 12fa9f18ed9fca608f272520072257ba61fd9eff25613f86d83d4fce14fc01f5
MD5 67714a5cdfa525ff0c010448e729394f
BLAKE2b-256 a847d5c277ace346d945e8410a5c2c6fb2e6764b7b37cd75e656de8b819cca50

See more details on using hashes here.

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