From be78d293727dc993a66efbf45e8c5cddf95643f3 Mon Sep 17 00:00:00 2001 From: Aumit Leon Date: Sun, 12 Aug 2018 16:49:17 -0400 Subject: [PATCH 1/5] Update information on mkdocs build process --- docs/builds.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/builds.rst b/docs/builds.rst index 3cdf2123651..c095a1abd15 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -42,7 +42,7 @@ MkDocs ~~~~~~ When you choose *Mkdocs* as your *Documentation Type*, -we will first look for a ``mkdocs.yml`` file in the root of your repository. +we will first look for a ``mkdocs.yml`` file in the ```doc``` or ```docs``` directory. If we don't find one, we will generate one for you. From a6ac3d5e327ed36e2742b985bebdfae016c32a85 Mon Sep 17 00:00:00 2001 From: Aumit Leon Date: Sun, 12 Aug 2018 21:57:42 -0400 Subject: [PATCH 2/5] add info on where build looks for markdown files --- docs/builds.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/builds.rst b/docs/builds.rst index c095a1abd15..f9ba25ec5f5 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -42,11 +42,11 @@ MkDocs ~~~~~~ When you choose *Mkdocs* as your *Documentation Type*, -we will first look for a ``mkdocs.yml`` file in the ```doc``` or ```docs``` directory. +we will first look for a ``mkdocs.yml`` file in the root of your repository, and if not found, within a ``doc`` or ``docs`` directory. If we don't find one, we will generate one for you. -Then MkDocs will build any files with a ``.md`` extension. +Then MkDocs will build any files with a ``.md`` extension within the ``doc`` or ``docs`` directory. As MkDocs doesn't support automatic PDF generation, Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option. From 8e318937204dc1fc39fd375039afb816c82d7888 Mon Sep 17 00:00:00 2001 From: Aumit Leon Date: Mon, 13 Aug 2018 14:45:11 -0400 Subject: [PATCH 3/5] add info on where markdown files should be --- docs/builds.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/builds.rst b/docs/builds.rst index f9ba25ec5f5..97b7ad00fd1 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -42,11 +42,11 @@ MkDocs ~~~~~~ When you choose *Mkdocs* as your *Documentation Type*, -we will first look for a ``mkdocs.yml`` file in the root of your repository, and if not found, within a ``doc`` or ``docs`` directory. +we will first look for a ``mkdocs.yml`` file in the root of your repository. If we don't find one, we will generate one for you. -Then MkDocs will build any files with a ``.md`` extension within the ``doc`` or ``docs`` directory. +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). As MkDocs doesn't support automatic PDF generation, Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option. From 4d6bb9b62553684343a0aa432f029579e2a84bc3 Mon Sep 17 00:00:00 2001 From: Aumit Leon Date: Mon, 13 Aug 2018 17:11:58 -0400 Subject: [PATCH 4/5] add detailed information mkdocs build --- docs/builds.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/builds.rst b/docs/builds.rst index 97b7ad00fd1..852b8548f9b 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -46,7 +46,12 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository. If we don't find one, we will generate one for you. -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). +Then MkDocs will build any files with a ``.md`` extension within the directory specifed as ``docs_dir`` in the ``mkdocs.yml``. + +If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you, +MkDocs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory. +The first of these directories that exists and contains files with a ``.md`` extension will be set to ``docs_dir`` within ``mkdocs.yml``, +and MkDocs will build the ``.md`` files in that directory. As MkDocs doesn't support automatic PDF generation, Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option. From bab54833c76bab6261daf74a81ba7d49caa02bed Mon Sep 17 00:00:00 2001 From: Aumit Leon Date: Wed, 15 Aug 2018 14:21:11 -0400 Subject: [PATCH 5/5] update to reflect rtd role in build process --- docs/builds.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/builds.rst b/docs/builds.rst index 852b8548f9b..b837f706b00 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -49,7 +49,7 @@ we will generate one for you. Then MkDocs will build any files with a ``.md`` extension within the directory specifed as ``docs_dir`` in the ``mkdocs.yml``. If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you, -MkDocs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory. +Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory. The first of these directories that exists and contains files with a ``.md`` extension will be set to ``docs_dir`` within ``mkdocs.yml``, and MkDocs will build the ``.md`` files in that directory. As MkDocs doesn't support automatic PDF generation,