Python sphinx 如何在Sphinx中获取cpp-Doxygen模块列表?
使用Doxygen注释块中的Python sphinx 如何在Sphinx中获取cpp-Doxygen模块列表?,python-sphinx,doxygen,Python Sphinx,Doxygen,使用Doxygen注释块中的defgroupDoxygen关键字,可以定义“模块”。然后,在任何其他Doxygen注释块中,甚至在其他源文件中,使用ingroupDoxygen关键字,可以将cpp类和枚举添加到定义的模块中 然后,运行doxygen-doxyfile,生成文档,它有一个漂亮的模块选项卡,其中列出了所有定义的模块,每行一个 我有一个C++项目,我也想在狮身人面像中生成doxGEN的这个模块列表。我启动了autodoc,呼吸和呼气sphinx扩展 运行makehtml运行Doxyge
defgroup
Doxygen关键字,可以定义“模块”。然后,在任何其他Doxygen注释块中,甚至在其他源文件中,使用ingroup
Doxygen关键字,可以将cpp类和枚举添加到定义的模块中
然后,运行doxygen-doxyfile
,生成文档,它有一个漂亮的模块选项卡,其中列出了所有定义的模块,每行一个
<>我有一个C++项目,我也想在狮身人面像中生成doxGEN的这个模块列表。我启动了autodoc,呼吸和呼气sphinx扩展
运行makehtml
运行Doxygen并生成sphinx文档,但sphinx中缺少Doxygen生成的模块列表。在conf.py
中,我有
# Setup the `exhale` extension
exhale_args = {
# These arguments are required.
"containmentFolder": "./api",
"rootFileName": "library_root.rst",
"rootFileTitle": "Library API",
sphinx/呼气生成的api/library\u root.html
有一个很好的可扩展的所有名称空间列表,每个名称空间都包含它的所有类和枚举。它还有一个很好的可扩展列表,列出了项目中的所有目录,每个目录都有它的所有文件
所以我的问题是-我如何让sphinx也生成doxygen能够顺利生成的模块列表?无论是在library\u root.html还是其他html文件中
我发现,如果我使用name
Doxygen关键字,比如:name module1
在Doxygen注释中(带前导反斜杠或at符号),呼吸似乎能识别它,而它似乎不能识别并忽略defgroup
/ingroup
。
因此,在rst文件中,我可以手动地说
.. doxygengroup:: module1
:outline:
.. doxygengroup:: module2
:outline:
.. doxygengroup:: module3
:outline:
为了获得模块列表,(它们被标记为group
而不是module
),但我希望这是自动生成的,就像在Doxygen中一样,我只是在源代码中的Doxygen注释中定义模块,然后它们都出现在Doxygen输出的模块选项卡中,而无需执行任何其他操作。我希望它们被标记为module
,但我可以和group
一起生活,只要它有效
我还尝试添加了index.rst
.. automodule:: My Project
:members:
在之前。。toctree::
但这没有效果,它可能只在Python中工作。
我使用Linux,在一台机器上有Sphinx 1.6.7,在另一台机器上有Sphinx 1.8.5,Python 2.7我一直在寻找相同的功能,但看起来好像没有。我在repo的
呼气/graphs.py
中看到了一条关于组的注释,该列表正在填充,但未被使用。我正在寻找相同的功能,但看起来好像不存在。我在回购协议中看到,在呼气/graphs.py
中,似乎有一条关于组的评论,该列表正在填充,但未被使用。