Question

我知道如何通过设置“ add_module_names = False”来删除automodule指令中函数的模块前缀。 Remove package and module name from sphinx function

但是，它不能删除automodule指令中args的模块前缀。以下是自动模块生成的文档。

您会看到self arg的数据类型具有一个长前缀，例如“ PyPhysLeo.data_core”。

data_core子模块

类BufferDataD 同时管理CPU缓冲区和GPU缓冲区的类，数据类型为double

CPU2GPU（自身：PyPhysLeo.data_core.BufferDataD）→无

GPU2CPU（自己：PyPhysLeo.data_core.BufferDataD）→无

allocateCPU（自身：PyPhysLeo.data_core.BufferDataD）→无

allocateGPU（自身：PyPhysLeo.data_core.BufferDataD）→无

setZeroCPU（自身：PyPhysLeo.data_core.BufferDataD）→无

setZeroGPU（自身：PyPhysLeo.data_core.BufferDataD）→无

size（self：PyPhysLeo.data_core.BufferDataD）→int

Answer 1

pybind11生成的签名总是长而乏味的（具有自arg，类型可能具有长模块前缀）。因此，最好的方法是通过向模块init函数中添加代码py::options options;options.disable_function_signatures();来禁用这些签名。然后，您需要在文档字符串的第一行中编写自己的签名，例如

setZeroGPU() -> None

    reset GPU buffer data to zero

    :return: None
    :rtype: None

setZeroGPU（）->无是签名，它位于第一行。

由于默认情况下conf.py中的“ autodoc_docstring_signature”设置为True，因此sphinx将自动尝试从文档字符串的第一行读取函数签名。最后，您可以获得一个漂亮的文档。

setZeroGPU() → None
    reset GPU buffer data to zero

    返回: None
    返回类型:   None

sphinx删除自动模块中的参数的模块前缀

1 个答案: