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

问题描述

我知道如何通过设置"ADD_MODULE_NAMES=FALSE"来删除自动模块指令中函数的模块前缀。Remove package and module name from sphinx function

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

您可以看到self arg的数据类型有一个长前缀，如"PyPhysLeo.data_core"。

---

data_core子模块

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

CPU2GPU(自身：PyPhysLeo.data_core.BufferDataD)→无

GPU2CPU(自身：PyPhysLeo.data_core.BufferDataD)→无

allocateCPU(self：PyPhysLeo.data_core.BufferDataD)→无

分配GPU(自身：PyPhysLeo.data_core.BufferDataD)→无

setZeroCPU(self：PyPhysLeo.data_core.BufferDataD)→无

setZeroGPU(自身：PyPhysLeo.data_core.BufferDataD)→无

Size(self：PyPhysLeo.data_core.BufferDataD)→int

---

解决方案

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

setZeroGPU() -> None

    reset GPU buffer data to zero

    :return: None
    :rtype: None

setZeroGPU()->None是签名，位于第一行。

因为在默认情况下，conf.py中的"AutoDOC_DOCSTRING_SIGNITY"被设置为True，所以Shinx将自动尝试从第一行DOCSTRING读取函数签名。最后，你可以得到这样一份漂亮的文档。

setZeroGPU() → None
    reset GPU buffer data to zero

    返回: None
    返回类型:   None