Sphinx

From FreeCAD Documentation
This page is a translated version of the page Sphinx and the translation is 100% complete.
Other languages:

Introduction

Sphinx est un système de documentation similaire à Doxygen, conçu principalement pour documenter le code Python. Avec l'utilisation de "Breathe", il peut également être utilisé pour analyser du code C++, afin qu'il puisse être utilisé dans des projets qui mélangent C++ et Python.

Visitez le site Web Sphinx pour en savoir plus sur le système et consultez le Sphinx manual pour les informations complètes.

Sphinx et FreeCAD

Ce document donne une brève introduction à Sphinx, en particulier comment il est utilisé dans FreeCAD pour documenter ses sources. Visitez la page Documentation du code source pour obtenir des instructions sur la création de la documentation FreeCAD, également hébergée en ligne sur FreeCAD API.

File:FreeCAD sphinx workflow.svg

Flux de travail général pour produire la documentation du code source avec Sphinx. (Note de l'éditeur: mettre à jour cette image)


Aperçu Sphinx et FreeCAD

Résultats encourageants de David_D:

Discussion sur le forum FreeCAD