boschglobal / doxysphinx

A lightweight Doxygen extension for Sphinx

Home Page:https://boschglobal.github.io/doxysphinx/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

A lightweight Doxygen extension for Sphinx

https://boschglobal.github.io/doxysphinx/

License:MIT License


Languages

Language:Python 83.8%Language:JavaScript 5.6%Language:HTML 3.4%Language:SCSS 2.8%Language:Dockerfile 2.3%Language:Makefile 1.4%Language:Shell 0.7%