From FreeCAD Documentation
This page is a translated version of the page Sphinx and the translation is 17% complete.
Other languages:


Sphinx is a documentation system similar to Doxygen, designed primarily to document Python code. With the use of "Breathe" it can also be used to parse C++ code, so it can be used in projects that mix C++ and Python.

Visit the Sphinx website to learn more about the system, and consult the Sphinx manual for the full information.

Sphinx and FreeCAD

This document gives a brief introduction to Sphinx, in particular how it is used in FreeCAD to document its sources. Visit the source documentation page for instructions on building the FreeCAD documentation, which is also hosted online on the FreeCAD API website.

File:FreeCAD sphinx workflow.svg

General workflow to produce source code documentation with Sphinx. (Editor's note: update this image)

Sphinx and FreeCAD Preview

Encouraging results from David_D:

FreeCAD Forum Discussion