Sphinx: Difference between revisions

From FreeCAD Documentation
(Visit the Sphinx website to learn more about the system, and consult the Sphinx manual for the full information.)
(Marked this version for translation)
Line 2: Line 2:
<translate>
<translate>


== Introduction ==
== Introduction == <!--T:1-->


<!--T:2-->
[[Sphinx|Sphinx]] is a documentation system similar to [[Doxygen|Doxygen]], designed primarily to document [[Python|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.
[[Sphinx|Sphinx]] is a documentation system similar to [[Doxygen|Doxygen]], designed primarily to document [[Python|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.


<!--T:3-->
Visit the [https://www.sphinx-doc.org/en/master/ Sphinx] website to learn more about the system, and consult the [https://www.sphinx-doc.org/en/master/contents.html Sphinx manual] for the full information.
Visit the [https://www.sphinx-doc.org/en/master/ Sphinx] website to learn more about the system, and consult the [https://www.sphinx-doc.org/en/master/contents.html Sphinx manual] for the full information.


== Sphinx and FreeCAD ==
== Sphinx and FreeCAD == <!--T:4-->


<!--T:5-->
This document gives a brief introduction to Sphinx, in particular how it is used in FreeCAD to document its sources. Visit the [[source_documentation|source documentation]] page for instructions on building the FreeCAD documentation, which is also hosted online on the [https://www.freecadweb.org/api/ FreeCAD API website].
This document gives a brief introduction to Sphinx, in particular how it is used in FreeCAD to document its sources. Visit the [[source_documentation|source documentation]] page for instructions on building the FreeCAD documentation, which is also hosted online on the [https://www.freecadweb.org/api/ FreeCAD API website].


<!--T:6-->
[[File:FreeCAD_sphinx_workflow.svg|800px]]
[[File:FreeCAD_sphinx_workflow.svg|800px]]


<!--T:7-->
{{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)}}



Revision as of 11:21, 15 May 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)