如何在sphinx文档中自动添加参数类型
我目前正在尝试使用Sphinx（使用扩展程序sphinx-apidoc和napoleon）实现自动文档创建。这个方法非常有效，但如果能够自动添加参数列表中的类型提示（PEP484约定），那就更好了。 我想知道这是否可能。 更具体地说： （来自napoleon示例）def function_...
使用NumPyDoc风格的Napoleon Sphinx扩展的类方法列表
我正在使用NumPyDoc风格的docstring来记录Python软件包。我想从'numpydoc' Sphinx扩展切换到Napoleon，因为我发现它以更紧凑和易读的方式格式化docstring。然而，它不会在文档顶部列出类的方法，而我发现这是numpydoc非常有价值的一个功能。有没有...
是否应该始终记录函数，即使是冗余的（特别是Python）？
我尝试使用具有活力和描述性的函数名称，然后使用具有活力和描述性的文本进行记录(!)。这会生成看起来冗余的代码。 以下是一个简化但并不太不切实际的Python示例，遵循NumPy docstring风格:def calculate_inverse(matrix): """Calcula...
如何在Python函数文档字符串中指定多个返回类型？
我了解Google风格编写文档字符串时所使用的语法，例如： def function_with_types_in_docstring(param1, param2): """Example function with types documented in the docstring...
Sphinx警告：autosummary：找不到类方法的桩文件。检查你的autosummary_generate设置。
我有一个开源软件包，其中包含许多不同子模块的类。所有类都具有方法fit和transform，并从sklearn继承fit_transform。所有类都具有遵循numpydoc格式的文档字符串，其中包含子标题参数、属性、注释、参见和方法，我在其中列出了fit、transform和fit_tran...
谷歌风格的文档字符串示例部分未呈现为代码片段。
我最近开始为我的项目添加文档，并尝试遵循Google风格指南。我正在使用Sphinx生成文档，并使用Sphinx扩展napoleon来弥补Google风格指南和reST之间的差距。 我可以轻松地呈现params和Notes，但是似乎无法使示例部分呈现代码片段。 class Chicken(...
“autodoc_default_flags”在Python Sphinx配置中是如何工作的？
我正在尝试使用Sphinx 1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展来为我的Python类生成文档。 我有很多模块，我希望每个模块只显示类名，而不是类中所有方法的完整列表（这些方法在我的代码中都有docstrings）。 以下是我的conf.py文件的...
sphinx.ext.napoleon中的参数能否有列表形式？
我正在使用sphinx自动文档扩展和sphinx.ext.napoleon。我遵循numpydoc样式指南，因为我认为它比google的更易读。然而，我注意到了以下问题，我无法解决。 我的问题是：在参数部分（或返回等部分）是否可以允许有一个列表？我想要像下面这样的东西： 更新根据Steve...
Sphinx Napoleon扩展：使用Google风格的文档字符串记录多个返回参数
这个问题与另一个问题有关。所提出和接受的解决方案是： Returns: (tuple): tuple containing: arg1: First Argument ...