如何解决使用 Sphinx 和 `sphinx.ext.autosummary` 为外部 `pybind11` 模块递归生成文档
我在使用 Sphinx 为 python 包生成文档时遇到问题,该包包含一个使用 pybind11
生成 Python 绑定的外部 c++ 模块。
我遇到的问题是编译后的 module
包含多个 submodules
,但带有 :recursive:
选项的自动摘要似乎只能找到最高级别模块的函数和类。我的印象是问题在于每个子模块没有明确的 __init__.py
文件,因为绑定都打包到一个 .so
二进制文件中。有没有办法解决这个问题?
我正在使用 Python 3.8
和 Sphinx 3.2.1
。这是我的index.rst
:
.. toctree::
:hidden:
Home page <self>
Examples <examples>
API reference <_autosummary/mypackage>
这是api.rst
:
API Reference
=============
.. autosummary::
:toctree: _autosummary
:template: custom-module-template.rst
:recursive:
mypackage
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。