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