Sphinx: Difference between revisions

From FreeCAD Documentation
No edit summary
(Add preview of sphinx breath extension)
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)}}


== FreeCAD Sphinx + Breathe Extension Preview ==
Encouraging results from David_D:

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

[[File:Freecad-sphinx-docs-preview.png]]


== FreeCAD Forum Discussion == <!--T:8-->
== FreeCAD Forum Discussion == <!--T:8-->

Revision as of 13:11, 26 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 Sphinx + Breathe Extension Preview

Encouraging results from David_D:

FreeCAD Forum Discussion