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

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

doxysphinx-3.3.12.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

doxysphinx-3.3.12-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file doxysphinx-3.3.12.tar.gz.

File metadata

  • Download URL: doxysphinx-3.3.12.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for doxysphinx-3.3.12.tar.gz
Algorithm Hash digest
SHA256 d84829e32a30e50929f1ec15816784d5f7f60321d8ca5bfde7bd8965d1740ddf
MD5 b828a1116ba66ffb555068fc7a228063
BLAKE2b-256 aa63c959bd579210f0a9d74618745744ac8d1ffaf566a52bfc52950d01736228

See more details on using hashes here.

File details

Details for the file doxysphinx-3.3.12-py3-none-any.whl.

File metadata

  • Download URL: doxysphinx-3.3.12-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for doxysphinx-3.3.12-py3-none-any.whl
Algorithm Hash digest
SHA256 9f97ecd3c598f7bbe761e613d0611f549f24f38ed4b55db11332e6ec201f7d10
MD5 5ccb91084f003eb977547cf5378fd7e7
BLAKE2b-256 9cd2439b48113d0cc4ad42b89c7be3fe28b8740c00e7f7ab7bd01353b932dacb

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