NumPy文档指南

用户文档

• 一般来说，我们遵循 Google developer documentation style guide .

• NumPy样式适用于以下情况：

  • 谷歌没有指导，或者

  • 我们不喜欢使用谷歌风格

  我们目前的规则：

  • 我们多元化 指数 作为 指数 而不是 indexes ，遵循 numpy.indices .

  • 为了保持一致性，我们还将其多元化 矩阵 作为 矩阵 .

• NumPy或Google规则未充分解决的语法问题由最新版本的“语法和用法”部分决定 Chicago Manual of Style .

• 我们欢迎成为 alerted 对于案例，我们应该加入NumPy风格的规则。

文档字符串

使用时 Sphinx 结合numpy约定，您应该使用 numpydoc 扩展，以便正确处理docstring。例如，Sphinx将提取 Parameters 从docstring中提取节并将其转换为字段列表。使用 numpydoc 还可以避免普通sphinx在遇到numpy docstring约定（如节头）时产生的restructuredtext错误。 ------------- ）那个Sphinx不会出现在docstring中。

本文档中描述的某些功能需要最新版本的 numpydoc . 例如， 产量 节已添加到 numpydoc 0.6。

可从以下网址获取：

• numpydoc on PyPI

• numpydoc on GitHub

注意，对于numpy中的文档，没有必要这样做 import numpy as np 在一个例子的开头。但是，一些子模块，例如 fft ，默认情况下不导入，必须显式包含它们：：

import numpy.fft

之后您可以使用它：

np.fft.fft2(...)

请使用numpydoc formatting standard 如他们的 example

Numpy的文档 构建numpy API和参考文档