You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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: pg-timetable
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.
The text was updated successfully, but these errors were encountered:
pashagolub
changed the title
Add a Sphinx 'conf.py` configuration file to documentation
Add a Sphinx conf.py configuration file to documentation
Jul 11, 2023
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:
pg-timetable
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.pyMkdocs example mkdocs.yml
Keep documenting,
Read the Docs
The text was updated successfully, but these errors were encountered: