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

mkdocs configuration file #82

Open
WolfgangFahl opened this issue Jul 13, 2023 · 0 comments
Open

mkdocs configuration file #82

WolfgangFahl opened this issue Jul 13, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@WolfgangFahl
Copy link
Owner

Hello,

Historically Read the Docs has created a docs/conf.py file for Sphinx projects and a mkdocs.yml file for MkDocs projects that don't provide one, to make onboarding easier. This has been confusing a lot our users in different ways and we will remove the auto-creation of a default Sphinx/MkDocs configuration file for projects that don't have one on August 28th. To avoid unexpected behavior or your documentation builds failing, you should add a configuration file to your project by this date. We are sending you this email because you are a maintainer of the following projects that are affected by this removal: pyceurmake The auto-creation of a default configuration file will be completely removed on August 28th. Add a conf.py/mkdocs.yml to your projects before this date to avoid unexpected build failures. You can find a good example of a basic configuration file in our example projects: Sphinx example conf.py Mkdocs example mkdocs.yml
Keep documenting, Read the Docs

Hello,

Historically Read the Docs has created a docs/conf.py file for Sphinx projects and a mkdocs.yml file for MkDocs projects that don't provide one, to make onboarding easier. This has been confusing a lot our users in different ways and we will remove the auto-creation of a default Sphinx/MkDocs configuration file for projects that don't have one on August 28th. To avoid unexpected behavior or your documentation builds failing, you should add a configuration file to your project by this date.

We are sending you this email because you are a maintainer of the following projects that are affected by this removal:

[pyceurmake](https://readthedocs.org/projects/pyceurmake/)

The auto-creation of a default configuration file will be completely removed on August 28th. Add a conf.py/mkdocs.yml to your projects before this date to avoid unexpected build failures.

You can find a good example of a basic configuration file in our example projects:

Sphinx [example conf.py](https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/conf.py)
Mkdocs [example mkdocs.yml](https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/mkdocs.yml)

Keep documenting,
Read the Docs

@WolfgangFahl WolfgangFahl self-assigned this Jul 13, 2023
@WolfgangFahl WolfgangFahl added the enhancement New feature or request label Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

1 participant