Skip to content

Commit 4d6bb9b

Browse files
authored
add detailed information mkdocs build
1 parent 8e31893 commit 4d6bb9b

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
@@ -46,7 +46,12 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository.
4646
If we don't find one,
4747
we will generate one for you.
4848

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

0 commit comments

Comments
 (0)