文件名称：cpp_doxygen_sphinx:C ++ Doxygen CMake Sphinx呼吸管道教程
文件大小：377KB
文件格式：ZIP
更新时间：2024-06-12 04:20:01
Python
Doxygen / CMake / Sphinx / Breathe供那些完全迷失的使用者 （我是一个完全迷失的人）。 这里的目标是为C++项目设置文档。 最终结果将是托管在GitHub的ReadTheDocs主题中的C++库文档，如下所示。 内容 这些自述文件将分为三部分： 在构建过程中出现一些有关缺少文档的警告。 这将通过将Doxygen合并到CMake来完成。 启用并运行一个实际上不错的（ ReadTheDocs ）网站。 这将使用Doxygen / Sphinx / Breathe管道完成。 我不会尝试将此步骤合并到CMake文件中-通常无论如何都是通过GitHub actions完成的。 获取GitHub actions以自动为我们构建和托管我们的文档。 资料来源 这些说明是我从这些不错的资源中学到的内容的汇总，因此应归功于以下几点： 网上散布着数百万个示例。
【文件预览】：
cpp_doxygen_sphinx-master
----docs_sphinx()
--------api()
--------Makefile(634B)
--------index.rst(587B)
--------conf.py(3KB)
--------make.bat(795B)
--------Doxyfile.in(109KB)
----.gitignore(55B)
----src()
--------cpp_doxygen_sphinx.cpp(149B)
----readme_figures()
--------pic1.png(96KB)
--------pic3.png(95KB)
--------header.jpg(60KB)
--------pic0.png(38KB)
--------pic2.png(80KB)
----.github()
--------workflows()
----README_sphinx.md(10KB)
----README.md(2KB)
----README_github.md(6KB)
----include()
--------cpp_doxygen_sphinx.hpp(173B)
----README_doxygen.md(8KB)
----docs_doxygen()
--------Doxyfile.in(109KB)
----CMakeLists.txt(2KB)