NumPy的文档 > 构建NumPy API和参考文档
我们目前使用Sphinx生成NumPy的API和参考文档。您将需要Sphinx 1.8.3 <= 1.8.5。
如果只想获取文档,请注意可以在以下位置找到预构建的版本
以几种不同的格式。
如果您是通过git获得的NumPy,则还要获取git子模块,其中包含构建文档所需的其他部分:
git submodule init
git submodule update
此外,构建文档还需要Sphinx扩展 plot_directive,它随Matplotlib一起提供。可以通过安装Matplotlib来安装此Sphinx扩展。您还将需要python3.6。
由于主要文档的大部分是通过numpy并通过检查文档字符串而获得
的,因此您需要首先构建NumPy,然后进行安装,以便导入正确的版本。import numpy
请注意,您可以例如。将NumPy安装到一个临时位置,并适当设置PYTHONPATH环境变量。
安装NumPy后,请安装SciPy,因为随机模块中的某些绘图需要scipy.special
正确显示。现在您可以生成文档了,所以写:
make html
在doc/
目录中。如果一切顺利,这将生成一个build/html
包含已构建文档的
子目录。如果收到有关的消息,则必须通过设置覆盖检查或重新安装NumPy。installed numpy != current repo git version
GITVER
请注意,虽然应该可以,但目前不积极支持在Windows上构建文档。(有关更多信息,请参见Sphinx文档。)
要构建PDF文档,请执行以下操作:
make latex
make -C build/latex all-pdf
您将需要为此安装Latex。
除了上述内容,您还可以执行以下操作:
make dist
它将重建NumPy,将其安装到临时位置,并以所有格式构建文档。这很可能仅在Unix平台上有效。
NumPy的文档也以html和pdf格式发布在https://docs.scipy.org。有关如何更新https://docs.scipy.org的详细信息,请参见HOWTO RELEASE。make dist