Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update information on mkdocs build process #4508

Merged
merged 5 commits into from
Aug 21, 2018
Merged

Update information on mkdocs build process #4508

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be78d29
Update information on mkdocs build process
AumitLeon Aug 12, 2018
a6ac3d5
add info on where build looks for markdown files
AumitLeon Aug 13, 2018
8e31893
add info on where markdown files should be
AumitLeon Aug 13, 2018
4d6bb9b
add detailed information mkdocs build
AumitLeon Aug 13, 2018
bab5483
update to reflect rtd role in build process
AumitLeon Aug 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/builds.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here it should say Read the Docs will attempt instead of MkDocs will attempt since this is something that RTD code does, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree-- that sounds better. I'll add that change!

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.

Expand Down