Sphinx: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Marked this version for translation)
 
(5 intermediate revisions by one other user not shown)
Line 5: Line 5:


<!--T:2-->
<!--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 [https://github.com/michaeljones/breathe "Breathe"] it can also be used to parse C++ code, so it can be used in projects that mix C++ and Python.


<!--T:3-->
<!--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 == <!--T:4-->
== Sphinx and FreeCAD == <!--T:4-->
Line 20: Line 20:
<!--T:7-->
<!--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)}}


== Sphinx and FreeCAD Preview == <!--T:9-->
Encouraging results from David_D:

<!--T:10-->
* [https://forum.freecadweb.org/viewtopic.php?p=411563#p411563 FreeCAD Forum Post]
* GitHub Repo - https://github.com/DavidDaish/freecad_sphinx_docs

<!--T:11-->
[[File:Freecad-sphinx-docs-preview.png]]


== FreeCAD Forum Discussion == <!--T:8-->
== 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]
* [https://forum.freecadweb.org/viewtopic.php?f=8&t=47229 Automatic Documentation Generation & Hosting]
* [https://forum.freecadweb.org/viewtopic.php?p=411563#p411563 FreeCAD Forum Post] - https://github.com/DavidDaish/freecad_sphinx_docs


</translate>
</translate>

Latest revision as of 17:24, 27 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)


Sphinx and FreeCAD Preview

Encouraging results from David_D:

FreeCAD Forum Discussion