Sphinx: Difference between revisions

From FreeCAD Documentation
(Add section linking to relevant FreeCAD Forum discussions)
(Marked this version for translation)
Line 21: Line 21:
{{Caption|General workflow to produce source code documentation with Sphinx. (Editor's note: update this image)}}
{{Caption|General workflow to produce source code documentation with Sphinx. (Editor's note: update this image)}}


== FreeCAD Forum Discussion ==
== FreeCAD Forum Discussion == <!--T:8-->
* [https://forum.freecadweb.org/viewtopic.php?f=23&t=44612#p381168 This is now a thread about documentation]
* [https://forum.freecadweb.org/viewtopic.php?f=23&t=44612#p381168 This is now a thread about documentation]
* [https://forum.freecadweb.org/viewtopic.php?f=22&t=47132&p=405381#p405379 Documenting Python Extensions]
* [https://forum.freecadweb.org/viewtopic.php?f=22&t=47132&p=405381#p405379 Documenting Python Extensions]

Revision as of 06:02, 6 June 2020

Other languages:

Introduction

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)

FreeCAD Forum Discussion