Skip to content

Commit d907524

Browse files
committed
Remove note about changing README to index
1 parent 6e59fd0 commit d907524

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

docs/builds.rst

+3-7
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ We will look inside a ``doc`` or ``docs`` directory first,
3737
and then look within your entire project.
3838

3939
Then Sphinx will build any files with an ``.rst`` extension.
40-
If you have a ``README.rst``,
41-
it will be transformed into an ``index.rst`` automatically.
4240

4341
Mkdocs
4442
~~~~~~
@@ -50,11 +48,9 @@ we will generate one for you.
5048
We will look inside a ``doc`` or ``docs`` directory first,
5149
and then default to the top-level of your documentation.
5250

53-
Then Mkdocs will build any files with an ``.md`` extension.
54-
If you have a ``README.md``,
55-
it will be transformed into an ``index.md`` automatically.
56-
As MkDocs doesn't support automatic PDF generation,
57-
Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option.
51+
Then Mkdocs will build any files with an ``.md`` extension. As MkDocs doesn't
52+
support automatic PDF generation, Read the Docs cannot create a PDF version of
53+
your documentation with the *Mkdocs* option.
5854

5955
Understanding what's going on
6056
-----------------------------

0 commit comments

Comments
 (0)