如何解决在 Sphinx 的两页上记录一个函数?
我有一个使用 Sphinx 记录的 C API。我想要一个包含大多数用户需要的所有东西的“API Essentials”页面,以及一个记录所有内容的“Full API”页面。问题是,我找不到在两个地方记录相同功能的好方法。我已经尝试了一些东西:
天真的选择是在两个地方正常记录函数:
essentials.rst:
.. c:function:: void foo(int arg)
Does foo
:param arg: Argument for foo
full.rst:
.. c:function:: void foo(int arg)
Does foo
:param arg: Argument for foo
这给出了 WARNING: Duplicate C declaration
,但确实有点工作。问题(除了警告)是我无法从交叉引用和索引中选择两个页面中的哪一个链接,而 Sphinx 选择了错误的一个。
noindex 选项 是将 :noindex:
添加到其中一个以强制索引并交叉引用另一个。但是C域好像不支持这个,因为我得到WARNING: Error in "function" directive: unkNown option: "noindex"
有一个 :noindexentry:
选项被接受,但不会改变索引和交叉引用的行为。
essentials.rst:
.. c:function:: void foo(int arg)
Does foo
:param arg: Argument for foo
full.rst:
.. c:alias:: foo
Does foo
:param arg: Argument for foo
这消除了所有警告并使索引和交叉引用正确,但别名仅显示签名。它不显示功能描述或参数。
有没有办法在不影响原始函数的情况下为函数或其他 C 结构添加重复文档?我使用的是 Sphinx 4.0.2。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。