问题标签 [numpydoc]

让我们考虑以下示例：

关于如何正确记录上述代码的任何建议？我正在使用Sphinx和numpydoc。

非常感谢！

编辑：我意识到我的问题不是很清楚，所以我要补充几句。x基本上，主要问题是如何记录作为float, list or array输入和输出的事实float or array。我在一些例子中看到这应该是getter唯一的，我不知道我是否应该添加关键字Parameters，Returns或者它是否是更好的方法，因为我没有找到足够的答案（或者我只是想念他们）。

我面临着这个问题中讨论的同样问题：Furo Sphinx theme uppercases too much in API documentation。但是，接受的解决方案不起作用，似乎 Furo 模板以某种方式覆盖了custom.css：

我很感激在Furo Sphinx 主题中实现这个简单的自定义的任何帮助。

我正在为一个包开发文档，当我构建 sphinx 文档时，我得到了双冒号

对于每个函数定义的所有字段。

我正在为我的文档字符串使用 numpydoc 样式，并且这些文档中没有冒号来指示它们可能来自哪里：

有没有人遇到过这个？值得注意的是，这不会发生在该Examples领域。只是Parameters,Returns和Return Type.

模块命令行参数的标准 sphinx 文档字符串格式是什么？例如：

我宁愿手动记录这一点，也不愿使用 sphinx argparse 扩展。我考虑过对模块文档字符串使用下面的方法，但我现在不考虑它是否是标准方法，也不考虑如何指示-f标志。此外，我实际上使用的是 numpy 样式的文档字符串，但我将标准 sphinx 格式留在这里，以便更多人能够理解它。