Sphinx自动文档和NumpyDoc
尽管我已经阅读了这个教程, 这个问题和numpy文档字符串标准, 但我仍然无法使sphinx autodoc与numpy文档字符串很好地配合使用。 在我的conf.py中，我有： extensions = ['sphinx.ext.autodoc', 'numpydoc'] 在我的文档...
在Sphinx中，是否有可能隐藏Python函数参数？
假设我有以下函数，在Numpydoc样式中记录了文档，并且使用Sphinx的autofunction指令自动生成了文档：def foo(x, y, _hidden_argument=None): """ Foo a bar. Parameters ------...
有没有办法对Python文件进行lint以检查是否符合Numpy文档风格？
我正在为一个需要Numpy文档的项目工作。在我使用Java的日子里，我记得在Eclipse/IDEA中有检查Javadoc遵从性的代码检查器。是否有类似的检查器可以检测Numpy文档的风格是否符合规范？ 我知道PEP257，但它似乎没有针对Numpy文档的特定检查。
sphinxcontrib.napoleon和numpy.numpydoc之间的区别
我正在使用Numpy风格的文档字符串为Python项目编写文档。 numpydoc 和 napoleon 是两个Sphinx扩展，用于解析Numpy风格的文档字符串以生成文档。第一个扩展被用于Numpy项目本身，而第二个扩展则随Sphinx一起发布。 使用其中一个扩展有哪些优缺点？
使用NumPyDoc风格的Napoleon Sphinx扩展的类方法列表
我正在使用NumPyDoc风格的docstring来记录Python软件包。我想从'numpydoc' Sphinx扩展切换到Napoleon，因为我发现它以更紧凑和易读的方式格式化docstring。然而，它不会在文档顶部列出类的方法，而我发现这是numpydoc非常有价值的一个功能。有没有...
是否应该始终记录函数，即使是冗余的（特别是Python）？
我尝试使用具有活力和描述性的函数名称，然后使用具有活力和描述性的文本进行记录(!)。这会生成看起来冗余的代码。 以下是一个简化但并不太不切实际的Python示例，遵循NumPy docstring风格:def calculate_inverse(matrix): """Calcula...
Sphinx警告：autosummary：找不到类方法的桩文件。检查你的autosummary_generate设置。
我有一个开源软件包，其中包含许多不同子模块的类。所有类都具有方法fit和transform，并从sklearn继承fit_transform。所有类都具有遵循numpydoc格式的文档字符串，其中包含子标题参数、属性、注释、参见和方法，我在其中列出了fit、transform和fit_tran...
我该如何解析numpydoc文档字符串并访问其中的组件？
我希望能够通过程序解析numpydoc文档字符串，并以编程方式访问每个组件。 例如： def foobar(a, b): '''Something something Parameters ---------- a : int, default: 5 ...
“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...