Sphinx

From FreeCAD Documentation
Revision as of 07:40, 21 May 2023 by Kaktus (talk | contribs) (Created page with "File:Freecad-sphinx-docs-preview.png")
Other languages:

Wprowadzenie

Sphinx jest systemem dokumentacji podobnym do Doxygen, zaprojektowanym głównie do dokumentowania kodu Python. Dzięki użyciu "Breathe" może być również używany do analizowania kodu C++, więc może być używany w projektach łączących C++ i Python.

Odwiedź stronę domową Sphinx, aby dowiedzieć się więcej o systemie i zapoznaj się z Podręcznikiem Sphinx, aby uzyskać pełne informacje.

Sphinx i FreeCAD

Niniejszy dokument zawiera krótkie wprowadzenie do Sphinx, w szczególności w jaki sposób jest on używany w FreeCAD do dokumentowania jego źródeł. Odwiedź stronę Dokumentacja źródeł, aby uzyskać instrukcje dotyczące tworzenia dokumentacji FreeCAD, która jest również dostępna online na witrynie FreeCAD API.

File:FreeCAD sphinx workflow.svg

Ogólny proces tworzenia dokumentacji kodu źródłowego za pomocą oprogramowania Sphinx.


Sphinx i FreeCAD zapowiedź

Zachęcające wyniki od David_D:

FreeCAD Forum Discussion