使用Sphinx渲染文档¶
使用以下命令将SciPy文档字符串呈现为HTML Sphinx 以及 PyData Sphinx theme 。有关编写文档字符串的内容，请参阅 Documentation style ；本文档介绍如何检查文档字符串是否正确呈现。
有关视频演练，请参阅 Rendering SciPy Documentation with Sphinx .
本地呈现文档¶
要在您自己的计算机上呈现文档，请执行以下操作：
确保您有一个有效的Science Py 开发环境 处于活动状态。你需要能够
import scipy不管Python的工作目录如何；python setup.py develop和conda develop来自 quickstart 指南使这成为可能。安装 Sphinx ， PyData Sphinx theme ， Sphinx-Panels 和 matplotlib 。例如，如果您使用的是Python的 Python 发行版，请在终端窗口中输入
conda install sphinx pydata-sphinx-theme sphinx-panels matplotlib --channel conda-forge。要求列表在scipy/doc_requirements.txt。在终端窗口中，浏览到
scipy/doc目录。请注意该文件的存在Makefile。执行
git submodule update --init。某些文档主题文件不随Main一起分发scipy存储库；这样可以使用以下工具使它们保持最新 git submodules 。请输入
make html-scipyorg。如果路径中有多个版本的Python，则可以通过追加以下内容来选择要使用的版本PYTHON=python3.9添加到此命令，其中python3.9将替换为您用于本网站开发的Python的名称。它使用 Make build automation tool 要执行文档生成指令，请使用Makefile。第一次这可能需要一段时间，但后续文档构建通常要快得多。在以下位置查看文档
scipy/doc/build/html-scipyorg。你可以从index.html浏览，或者您可以直接跳转到您感兴趣的文件。
注解
重建Sphinx文档时，对某些文档的更改不会生效。在这种情况下，您可以通过删除 scipy/doc/build 目录，然后再次构建。
检查云上的文档¶
一旦打开PR，您就可以检查文档是否在云上正确呈现。