Skip to content

Commit 6c0349a

Browse files
authored
Merge pull request #4508 from AumitLeon/patch-1
Update information on mkdocs build process
2 parents 6057ff9 + bab5483 commit 6c0349a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/builds.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository.
4747
If we don't find one,
4848
we will generate one for you.
4949

50-
Then MkDocs will build any files with a ``.md`` extension.
50+
Then MkDocs will build any files with a ``.md`` extension within the directory specifed as ``docs_dir`` in the ``mkdocs.yml``.
51+
52+
If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you,
53+
Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory.
54+
The first of these directories that exists and contains files with a ``.md`` extension will be set to ``docs_dir`` within ``mkdocs.yml``,
55+
and MkDocs will build the ``.md`` files in that directory.
5156
As MkDocs doesn't support automatic PDF generation,
5257
Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option.
5358

0 commit comments

Comments
 (0)