Sphinx est-il déjà adapté à la documentation C ++?
Je veux essayer des générateurs de documentation pour un nouveau projet en C++. Je pense que mes options sont Doxygen ou Sphinx. Comme j'ai des projets en Python pour lesquels j'aimerais utiliser Sphinx, je me demande si Sphinx est également le bon choix pour C++. Le site Web Sphinx déclare que C++ est pris en charge, mais je n'ai pas pu trouver de document pour me familiariser avec la documentation C++.
Une question similaire a déjà été discutée sur Stackoverflow et la réponse principale conclut:
pas encore pleinement utilisable,
mais continuez à regarder
Étant donné que la discussion a plus d'un an , je me demande si cette conclusion est toujours valable. Dois-je choisir Doxygen plutôt que Sphinx pour ma documentation C++?
Sphinx ne peut pas extraire la documentation des sources C++ en soi et par lui-même. Cependant, il existe des extensions, notamment Breathe , qui utilisent Doxygen pour extraire la documentation de C++. Je n'ai testé aucun de ceux-ci.
Pour C++, l'oxygène est très bon; Le support Sphinx de C++ se fait via Doxygen (en utilisant Breathe ).
Vous souhaitez disposer d'un seul outil pour les deux langues, afin d'améliorer la maintenabilité. Doxygen peut générer une documentation à partir de Python, donc je vous conseille d'utiliser Doxygen si possible pour les deux sources. Voici un tutoriel pour Doxygen et Python .