read-the-docs - ReadTheDocs を使用して docs ディレクトリの外に配置されたドキュメンテーション プロジェクトをビルドする方法は?

Question

を使用してドキュメント プロジェクトを生成してReadThedocs (mkdocs)います。ただし、ディレクトリ.mdに配置されたファイルのドキュメントプロジェクトを生成しています。docs私の要件は、.mdgithub リポジトリ内の任意の場所に配置されたすべてのファイルのドキュメント プロジェクトを構築することです。

これを達成する方法は？

Answer 1

Mkdocs 構成 ( mkdocs.yml) で、ドキュメント ディレクトリの場所を現在のディレクトリに指定する必要があります'.'。

例：

site_name: My Documentation Project
docs_dir: '.'

デフォルトでは、Mkdocs はプロジェクトのサブディレクトリを検索しますdocs。

docs_dir

ドキュメント ソースのマークダウン ファイルを含むディレクトリを設定できます。これは、構成ファイルを含むディレクトリに対して相対的に解決される相対ディレクトリにするか、絶対ディレクトリ パスにすることができます。

デフォルト：'docs'