问题标签 [numpydoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - 如何使用 NumpyDoc 正确记录属性
我正在管理一个使用 NumpyDoc 样式的包，并且我正在尝试正确记录某些属性的设置器/获取器。
特别是，我遇到了一个问题，即 setter 的文档被 python 忽略，因此所有文档都必须进入 getter。另一方面，同时拥有ReturnsandParameters字段似乎不是很直观。例如，可以像这样编写文档
但是这样做会变得非常混乱，何时以及如何应用Parameters和/或Returns。Parameters例如，仅适用于 setter 并且Returns仅适用于 getter并不明显（至少对我而言） 。
有没有一种标准的方法可以很好地与 NumpyDoc 以及各种文档解析器（例如 Sphinx）一起使用？
python - 带有 sphinx 新行的 Python 自动文档字符串
我想知道在使用 Sphinx 生成自动文档时如何换行。我没有使用默认的 Sphinx 文档字符串格式 reStructuredText，但我使用的是 Numpydoc 格式。我尝试使用 '\n' 但它会换行，我只需要一个新行。这是一个 Python 模块的示例...
python - Sphinx 未删除 html 输出中的 doctest 标志
我无法消除 html 输出的 doctest 标志（即<BLANKLINE>, # doctest: +ELLIPSIS）。我能够根据需要生成文档，因此没有错误，但它包含我想删除的这些标志。这里的Sphinx 文档声称这是可能的，所以我一定做错了什么。我的文档示例采用 numpy 风格，我尝试过使用 napoleon 和 numpydoc 扩展。
以下是我已采取的步骤。
- 运行
sphinx-quickstart（启用autodoc和doctest扩展） - 运行
sphinx-apidoc以生成 .rst 文件 - 运行
make doctest（所有测试都通过） - 跑
make html
我已经尝试了设置trim_doctest_flags和doctest_test_doctest_blocks变量conf.py，但没有成功。
我是否缺少一些东西来触发 sphinx 为 html 文档删除这些内容？我希望这是足够的信息来指出正确的方向，因为除了这个问题之外，文档看起来不错。但是，如有必要，我可以提供更多详细信息或示例。
更新：MCV 示例（使用 Sphinx 1.8.2）
目录和文件结构
配置文件
trial.rst - 这是使用 sphinx-apidoc 生成的
试用版.py
使用make html或sphinx-build -b html source build
trial.html 输出：
python - 在 sphinx 文档中写入 2 的幂
我尝试写 2 的幂，但我得到了一些奇怪的东西。
结果：
参数： X : np.ndarray, shape=(2\ n , 2 n )
第一个上标是错误的。我不希望 2 和 n 之间有任何斜线或空格。
python - 如何以 Numpydoc 格式记录多个返回值？
我正在尝试使用 numpy docstring 格式记录元组返回值，但无法使其与 pycharm 类型提示一起使用。
我尝试了多种方法，甚至找到了一种适用于该类型的方法，但不允许我为其每个元素添加描述。
要记录的函数示例：
现在，我可以记录它的一种方法是：
这会给我一个描述和正确的返回类型提示，但不是我想要的每个元素的单独描述。
这是我要实现的目标的非工作示例：
python-sphinx - 使用 numpydoc 和 sphinx 时格式损坏
我正在使用带有 numpydoc 扩展名的 sphinx。
当我制作 html 时，我的“示例”段落中的每个最后一项都被破坏了。
这就是我尝试制作的文件：
但是输出是这样的。 在最后一个元素处输出格式损坏的图像链接
这有什么问题？
已编辑
正如史蒂夫皮尔西所说，我改变了我的代码，它现在适用于gauss_elem.
但是，还有两个问题。
这是另一个文档字符串：
这是另一个格式损坏的输出。
python - 如何从 sphinx napoleon 和 numpy 样式文档中获得与默认 rst 方式相同的输出？
如果我采用非常简单的python文件：
我在参数之后得到类型：
如果我现在将 numpy 样式与拿破仑一起使用：
我最终得到了这个丑陋的设置
问题似乎是它nd_array不是一个有效的类型，对于默认的狮身人面像似乎不是问题，但对于拿破仑来说这似乎很重要，例如 typeint工作得很好。
python - 从第三方包继承时，Sphinx 和 Numpydoc 会引发解析错误
我正在尝试使用 Sphinx 和 numpydoc 来记录我的代码，但到目前为止非常不成功。当我尝试时，make html我得到了这个非常令人困惑的错误：
sphinx 无法解析的这个文档字符串来自我的代码继承类的依赖项。但是这种依赖是使用 Sphinx 和 numpy docstyle 本身（https://github.com/networkx/networkx）。所以我可以通过不从那个特定的类继承来摆脱错误，但这不是一个真正的解决方案。
我试图改变conf.py类似以使其适应第三方包。没有成功。另外，也许我可以阻止狮身人面像将其包含在文档中？想...
有谁知道我可以尝试什么？