我正在使用ReadThedocs
(mkdocs)
生成文档项目。但它正在为.md
文件生成文档项目,这些文件位于docs
目录中。我的要求是,我想为放置在github存储库中任何位置的每个.md
文件构建文档项目。
如何实现这一目标?
答案 0 :(得分:0)
您需要在Mkdocs配置(mkdocs.yml
)中指定documentation directory作为当前目录'.'
的位置。
示例:
site_name: My Documentation Project
docs_dir: '.'
默认情况下,Mkdocs会在项目的子目录中查找标有docs
的内容:
docs_dir
允许您设置包含文档源markdown文件的目录。这可以是相对目录,在这种情况下,它相对于包含您配置文件的目录进行解析,或者它可以是绝对目录路径。
默认:
'docs'