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.

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

Feature to disable auto-generated index.md/README.rst files #7305

Merged
merged 1 commit into from Jul 28, 2020

Conversation

humitos
Copy link
Member

@humitos humitos commented Jul 21, 2020

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.

Related to #2483

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.
Copy link
Member

@ericholscher ericholscher left a comment

This is a good first step towards turning this feature off all together 👍

@humitos humitos merged commit 92e2e7b into master Jul 28, 2020
2 checks passed
@humitos humitos deleted the humitos/flag-dont-create-index branch Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants