使用Sphinx按需記錄項目和模塊

Question

我使用Sphinx來記錄Python模塊。我有一個主目錄doc，我在其中將個別*.rst文件（對於每個模塊組件）都包含在index.rst主文件中。這很好（請檢查source of the Python Library Reference，看看我是如何做到的）。

我的問題是當我需要爲給定的模塊組件（而不是整個模塊）創建一個獨立的PDF。

假設您具有與完整模塊（庫）中的Python Library Reference相同的結構，然後您可以創建一個獨立的PDF來編寫文檔，例如crypto組件。你會怎麼做？

1. 創建一個不同的索引（index_2.rst）和僅包含文件（crypto.rst）
2. 評論從原來的index.rst
3. 其他文件與獨立的獅身人面像文檔
創建 crypto內一個全新的文檔目錄

沒有一種方法看起來很簡單。

請教。

Answer 1

首先我要創建一個模板，例如index_template.rst。接下來，我將編寫一個帶有一個參數的shell腳本。該參數將指定您想要生成的組件，否則它會爲所有組件生成index.rst。

然後自定義您的Makefile to support a component parameter。 Makefile會將此參數傳遞給每次生成新的index.rst的shell腳本。

這將允許你做這樣的事情：

$ make html 
$ make html component=crypto 

第一個命令會產生的一切文檔和第二會產生只是crypto組件。