使用 Pybind11 来封装 Python 模块,如何用 Sphinx 为其生成 API 文档?

查看 46|回复 1
作者:KADGang   
PYBIND11_MODULE(python_example, m) {
    m.doc() = R"pbdoc(
        Pybind11 example plugin
        -----------------------
        .. currentmodule:: python_example
        .. autosummary::
           :toctree: _generate
           add
           subtract
    )pbdoc";
    m.def("add", &add, R"pbdoc(
        Add two numbers
        Some other explanation about the add function.
    )pbdoc");
    m.def("subtract", [](int i, int j) { return i - j; }, R"pbdoc(
        Subtract two numbers
        Some other explanation about the subtract function.
    )pbdoc");
比如说我有这么一段代码,如何用 Sphinx 为python_example模块和它下面的函数生成 api 文档?我尝试过直接 make https://github.com/pybind/python_example 仓库的文档,但是生成的文档并没有包含这些内容。所以请教一下各位大佬如何处理这种情况。

pbdoc, add, subtract, pybind11

l1xnan   
官方有文档说明:
https://pybind11.readthedocs.io/en/stable/advanced/misc.html#generating-documentation-using-sphinx
有示例:
https://github.com/pybind/python_example
您需要登录后才可以回帖 登录 | 立即注册

返回顶部