Python 使用Sphinx按需记录项目和模块

我使用它来记录Python模块。我有一个主

doc

目录，在那里我放置了要包含在

索引.rst

主文件中的单个

*.rst

文件（对于每个模块组件）。这很好用（请查看我是如何做到的）

我的问题是当我需要为给定的模块组件（而不是整个模块）创建独立的PDF时

假设您的完整模块（库）具有与中相同的结构，然后您可以创建一个独立的PDF文档，例如

crypto

组件。你会怎么做

创建不同的索引（

index_2.rst

）并仅包括该文件（

crypto.rst

）

注释原始

index.rst中的其他文件

使用独立的Sphinx文档在

crypto

中创建一个全新的文档目录

这些方法似乎都不简单

---

请给我建议。

首先我要创建一个模板，比如

index\u template.rst

。接下来，我将编写一个接受一个参数的shell脚本。此参数将指定要生成的组件，否则将为所有组件生成index.rst

然后定制您的。Makefile会将此参数传递给shell脚本，该脚本每次生成一个新的

index.rst

这将允许您执行以下操作：

$ make html
$ make html component=crypto

---

第一个命令将为所有内容生成一个文档，第二个命令将只生成

加密组件。
您最好在这里问一个问题：。尽管有很多关于S.O.标记的“sphinx”的问题，但大多数问题与Python文档工具无关：(