Skip to main content

Integrates doxygen html documentation with sphinx.

Project description

doxysphinx

License Pypi package supported Python versions Build action: CI Build action: CD

Doxysphinx is a Doxygen and Sphinx integration tool.

It is an easy-to-use cli tool and typically runs right after Doxygen generation. It reuses the Doxygen generated HTML output and integrates it into Sphinx document generation. With this, Doxysphinx supports all known Doxygen features and at the same time integrates well with the Sphinx output (for example, Sphinx-Themes, search etc.). Doxysphinx, also supports restructured text (rST) annotations within C++ files.

Internally, Doxysphinx creates an rST file for each (Doxygen) HTML file and includes the HTML using .. raw:: html directive. Later Sphinx picks up these rST files and creates an integrated documentation.

Check out Doxysphinx alternatives here.

Links

📚 Doxysphinx Overview

🚀 Getting Started

💻 Developer Quickstart

🤖 Releases

Download files

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

Source Distribution

doxysphinx-2.3.6.tar.gz (25.5 kB view hashes)

Uploaded source

Built Distribution

doxysphinx-2.3.6-py3-none-any.whl (31.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page