如何使用ReadTheDocs構建放置在docs目錄之外的文檔項目？

Question

我正在使用ReadThedocs(mkdocs)生成文檔項目。但它正在生成.md文件的文檔項目，這些文件位於docs目錄中。我的要求是，我想爲github存儲庫中任何位置的每個.md文件構建文檔項目。

如何實現這一目標？

Answer 1

您需要在Mkdocs配置（mkdocs.yml）中指定documentation directory的位置爲當前目錄'.'。

例子：

site_name: My Documentation Project 
docs_dir: '.' 

默認情況下，Mkdocs看起來在你的項目的子目錄標有docs：

docs_dir

允許您設置包含文檔的源降價文件的目錄。這可以是相對目錄，在這種情況下，它是相對於包含配置文件的目錄進行解析的，也可以是絕對目錄路徑。

默認值：'docs'