Как создать проект документации, размещенный за пределами каталога docs, используя ReadTheDocs?

Question

Я создаю проект документации с использованием ReadThedocs(mkdocs). Но это проект документации для файлов .md, которые размещены в каталоге docs. Мое требование: я хочу построить проект документации для каждого файла .md, размещенного в любом месте репозитория github.

Как достичь этого?

Answer 1

Необходимо указать в конфигурации Mkdocs (mkdocs.yml) местоположение вашего documentation directory как текущий каталог '.'.

Пример:

site_name: My Documentation Project 
docs_dir: '.' 

По умолчанию Mkdocs смотрит в подкаталог вашего проекта помечены docs:

docs_dir

Позволяет установить каталог, содержащий файлы уценки исходные документы , Это может быть либо относительный каталог, и в этом случае он разрешен относительно каталога, содержащего ваш файл конфигурации, или может быть абсолютным пути к каталогу.

по умолчанию: 'docs'