我们使用 Sphinx 生成 API 和参考文档。

预构建版本可在以下位置找到：

https://networkx.cn/

适用于稳定版和最新版（即开发版）。

说明

安装 NetworkX 及其依赖项后，进入根目录并执行以下命令，安装构建文档所需的 Python 包：

pip install -r requirements/doc.txt

构建示例库还额外需要 requirements/extra.txt 和 requirements/example.txt 中列出的依赖项。

pip install -r requirements/extra.txt
pip install -r requirements/example.txt

要构建 HTML 文档，请进入 doc/ 目录并执行：

make html

这将生成一个包含构建好的文档的 build/html 子目录。如果 extra.txt 和 example.txt 中的依赖项未安装，则使用以下命令构建不生成图的 HTML 文档：

make html-noplot

要构建 PDF 文档，请进入：

make latexpdf

为此，你需要安装 LaTeX。

注意

sphinx 支持许多其他输出格式。输入不带任何参数的 make 命令，即可查看所有内置选项。