Quelles sont les principales différences de Sphinx et Doxygen?

Je veux préparer une documentation pour une collection de projets, des modules et des bibliothèques dans le domaine de la vision par ordinateur (principalement écrit en c++). À cette fin, j'ai eu un coup d'oeil sur OpenCV documentation et comme vous le savez peut OpenCV 2.4.x documentation est basée sur Sphinx et C'était exactement la solution que je cherchais. les caractéristiques intéressantes de Sphinx sont:

  1. Structure hiérarchique de modules dans un point de vue sémantique. Par exemple Filtre de Kalman est un enfant de d'Analyse de Mouvement et de Suivi d'Objet module
  2. Vous pouvez ajouter images et aussi les mathématiques formules
  3. Assez bien intégré moteur de recherche

Mais j'ai réalisé que la version c++ de OpenCV3.0 est documenté, basé sur Doxygen et je ne sais pas pourquoi! parce qu'il n'est pas aussi intéressant que le Sphinx.
Je sais que Doxygen pouvez compiler votre code et extraire vos commentaires qui est une fonction utile. Je sais aussi qu'il existe des bibliothèques (comme respirer) qui pourrait agir comme un pont entre Doxygen et Sphinx.

Maintenant mes questions sont:

  1. Sont Sphinx et Doxygen alternatives les unes des autres ou ils pourraient être utilisés à côté?
  2. Ne Doxygen ont les caractéristiques mentionnées de Sphinx?
  3. Qui moteur de documentation (Sphinx, Doxygen ou d'autres moteurs) préférez-vous pour mon problème?
Le Sphinx dit que c'est un Python outil de documentation. Je sais que Doxygen peut analyser le langage C++.
Exactement c'est mon problème. Mais je me demande comment est la version c++ de OpenCV documenté à l'aide de Sphinx!!!
C'est un excellent, mais peut-être un peu large, question. Il m'a incité à demander stackoverflow.com/questions/31594254/.... Comme pour combien de OpenCV2 est documenté par des sphinx, il utilise le sphinx c++ de domaine, et est relativement simple à suivre dans le cmake construire régime.
stackoverflow.com/questions/31594254/... n'existe pas (ou plus).

OriginalL'auteur Ali Mirzaei | 2015-07-22

  1. 6

    Cette réponse adresses le point 2 de votre question.

    Oui, doxygen en partie a ces caractéristiques.

    • Vous pouvez avoir les formules mathématiques, qui peut être rendu que ce soit à travers un local Latex installer, ou bien que MathJax, une bibliothèque de rendu javascript. Comme avec le Latex, ils peuvent être "embedded" dans un texte, ou comme une unité distincte dans le flux de texte.
    • Il comprend également un le moteur de recherche.
    • Vous pouvez facilement inclure des images.

    Par exemple, les deux lignes ci-dessous s'ajouter la même image à la fois en html et latex généré de sortie:

      \image latex my_image.png "My image" width=10cm
  \image html my_image.png "My image" width=10cm

    Je crois me rappeler qu'en html, la légende et la largeur sont ignorés ? Mais doxygen est vraiment souple, donc si la commande ci-dessus n'est pas assez, vous pouvez simplement ajouter le code html:

    <img src="my_image.png"  ...additional html attributes...>

    Doxygen prend en charge aussi beaucoup de régulièrement des commandes html que vous pouvez inclure directement dans votre bloc de commentaire.

    Je n'ai aucune expérience avec Sphinx autres que la construction d'Opencv manuel, mais ce que je peux ajouter sur doxygen (que j'utilise sur une base quotidienne), c'est qu'il est vraiment très souple, mais cela ne signifie pas qu'il est toujours le meilleur choix. Les Pages peuvent obtenir encombré et si le commentaire de code supplémentaire est mal conçu, il peut obtenir sur votre chemin.

    Pour l'exhaustivité, l'une des meilleures vitrines de ce que doxygen peut le faire (en plus de l'doxygen site web du cours), est le Propres de la bibliothèque. Prendre un coup d'oeil.

    OriginalL'auteur kebs