如何使用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'