Feature to disable auto-generated index.md/README.rst files #7305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When Read the Docs detects that your project doesn't have an ``index.md`` or ``README.rst``, it auto-generates one for you with instructions about how to proceed. This behavior may be a problem for some users and they will want to disable it. This is happening for example when building with MkDocs and setting ``` theme: static_templates: - index.html ``` Since there is no `index.md`, Read the Docs will create one from our template and it will override the `index.html` the user wants to show.
3 tasks
ericholscher
approved these changes
Jul 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When Read the Docs detects that your project doesn't have an
index.mdorREADME.rst, it auto-generates one for you with instructions about how toproceed. This behavior may be a problem for some users and they will want to
disable it.
This is happening for example when building with MkDocs and setting
Since there is no
index.md, Read the Docs will create one from our templateand it will override the
index.htmlthe user wants to show.Related to #2483