我正在使用ReadThedocs
(mkdocs)
. .md
但它正在为放置在docs
目录中的文件生成文档项目。我的要求是,我想为.md
放置在 github 存储库中任何位置的每个文件构建文档项目。
如何做到这一点?
我正在使用ReadThedocs
(mkdocs)
. .md
但它正在为放置在docs
目录中的文件生成文档项目。我的要求是,我想为.md
放置在 github 存储库中任何位置的每个文件构建文档项目。
如何做到这一点?
您需要在 Mkdocs 配置 ( mkdocs.yml
) 中将文档目录的位置指定为当前目录'.'
。
例子:
site_name: My Documentation Project
docs_dir: '.'
默认情况下,Mkdocs 在您的项目的子目录中查找 labelled docs
:
docs_dir
让您设置包含文档源 Markdown 文件的目录。这可以是相对目录,在这种情况下,它是相对于包含您的配置文件的目录进行解析的,也可以是绝对目录路径。
默认:
'docs'
默认情况下,这在 MkDocs 中是不可能的。有关基本原理,请参阅此GitHub 问题线程。然而,有一个名为mkdocs-same-dir的插件可用于实现此目的。