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.14.tar.gz (34.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doxysphinx-3.3.14-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: doxysphinx-3.3.14.tar.gz
  • Upload date:
  • Size: 34.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.11.0-1018-azure

File hashes

Hashes for doxysphinx-3.3.14.tar.gz
Algorithm Hash digest
SHA256 e6bb1ea452c8471c41a6ad53aed5b9eae50a247b823e0b40684050cc9b8feb7f
MD5 cf34ee949023976872d5fa6d99990c3b
BLAKE2b-256 0b9c12c35f953f7737582229ac683ebb3cc52030b8004294733e16b3699468dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: doxysphinx-3.3.14-py3-none-any.whl
  • Upload date:
  • Size: 42.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.11.0-1018-azure

File hashes

Hashes for doxysphinx-3.3.14-py3-none-any.whl
Algorithm Hash digest
SHA256 682a28d76bd7524a133615351d2b11072c9eb22158b5c9bc60285cf553f1ed84
MD5 5eedd380f7b5cc675d46db465732643f
BLAKE2b-256 4939be77b97820dbfa0a510ea3215f799bf8a21b1b923cb1b9feaffc3de4eba1

See more details on using hashes here.

Supported by

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