首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何将Doxygen输出呈现为减价而不是reST (使用reST或MyST-Parser)

如何将Doxygen输出呈现为减价而不是reST (使用reST或MyST-Parser)
EN

Stack Overflow用户
提问于 2021-12-09 16:06:01
回答 2查看 497关注 0票数 1

我正在使用Sphinx编写一个项目文档,在哪里获取Doxygen XML output,我使用了呼吸。我在.rst文件中使用了files指令。

sample.cpp

代码语言:javascript
复制
namespace X{
class A{
   public:
       int x;
};
}

在我的rst文件中我刚刚添加了

代码语言:javascript
复制
.. doxygenclass:: X::A
   :members:
   :protected-members:
   :private-members:

在构建项目之后,我可以看到class A的详细文档。出于某种原因,我打算使用markdown文件而不是.rst

我已经过了几个职位,但没有找到任何有成效的答案。这是我买到的最好的这个StackOverflow的答案

  • 我安装了myst解析器
  • 通过添加conf.py修改extensions = ["myst_parser",]

编写一个.md文件如下所示:

代码语言:javascript
复制
# sample_md
```{doxygenclass:: X::A}

*成员:

*受保护-成员:

*私人成员:

代码语言:javascript
复制

但在错误消息为

代码语言:javascript
复制
WARNING: unknown directive or role name: doxygenclass::A
/net/users/Linux_Home/user_name/project_name/doc/md_files/sample_mark.md:5: WARNING: Unknown directive type "doxygenclass::A".

也试过

代码语言:javascript
复制
# sample_md
```{doxygenclass}

一个

*成员:

*受保护-成员:

*私人成员:

代码语言:javascript
复制

也失败了,错误消息

代码语言:javascript
复制
Exception occurred:
  File "/net/users/Linux_Home/user_name/.local/lib/python3.8/site-packages/myst_parser/docutils_renderer.py", line 973, in run_directive
    if issubclass(directive_class, Include):
TypeError: issubclass() arg 1 must be a class
The full traceback has been saved in /tmp/sphinx-err-guubfd6h.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make[2]: *** [doc/CMakeFiles/Sphinx.dir/build.make:63: doc/sphinx/index.html] Error 2
make[1]: *** [CMakeFiles/Makefile2:215: doc/CMakeFiles/Sphinx.dir/all] Error 2
make: *** [Makefile:130: all] Error 2

现在不知道该怎么做。

我在.md文件中使用了下面的代码片段

代码语言:javascript
复制
```{cpp:class} X::A
代码语言:javascript
复制

它显示了类的呈现,但仅显示了一个可单击链接的名称,其中没有任何Doxygen文档。我需要那个信息。

我的一些纪念活动是:

  • myST仅用于在标记文件中收集Sphinx directive
  • 呼吸是一种获取Doxygen XML output并使用SphinxreST样式编写的工具。

现在我想知道,是否可以在breathe Doxygen directive文件中添加.md?如果是的话,我在哪里把语法搞错了?

EN

回答 2

Stack Overflow用户

发布于 2021-12-10 11:43:11

得到答案了,这里

现在,标记文件如下所示

代码语言:javascript
复制
```{eval-rst}

。。doxygenclass::X::A

代码语言:javascript
复制
票数 1
EN

Stack Overflow用户

发布于 2021-12-09 18:17:44

你能试试这个吗?

代码语言:javascript
复制
```{doxygenclass} X::A

*成员:

*受保护-成员:

*私人成员:

代码语言:javascript
复制

如果失败了,报告错误?

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/70293037

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档