使用Sphinx生成Python文檔使用：glob：

Question

我是獅身人面像的新手。

文件/home/user/myproject/docs/source/index.rst是如下：

My project contents: 

.. toctree:: 
    :glob: 

    * 

我收到以下消息上運行/home/user/myproject/docs/下$ make html：

checking consistency... /home/user/myproject/docs/source/design/index.rst:: WARNING: document isn't included in any toctree 

我有什麼錯呢？我希望Sphinx根據目錄層次自動生成結構。

Answer 1

我不認爲這是一項支持的操作。

幸運的是，它不是一個非常理想的選擇，因爲您通常希望文檔的某些部分以特定順序顯示。

Answer 2

如果你願意只在source轉儲所有的源文件沒有文件夾heirarchy，這是可能的。或者，您可以在致電sphinx-build之前編寫例程並從Makefile運行它。

正如Mike所提到的，:glob:只會按文件名的字母順序提取文件。 See the docs here。

通過給出glob標誌選項，可以在toctree指令中使用「globbing」。然後將所有條目與可用文檔列表進行匹配，並按字母順序將匹配插入到列表中。

如果你想使用:glob:和維護source與您的所有文件排序，你需要用數字前綴您.rst文件。

例

source 
├── index.html 
├── 1_intro.rst 
├── 2_install.rst 
└── 3_more-than-you-want-to-know.rst 

雖然，你當然會需要的，如果你決定要命令他們不同，而不是在index.rst移動明確列表的順序重命名這些文件。