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

Deprecation of projects using Sphinx or MkDocs without an explicit configuration in their .readthedocs.yaml file #136

Open
dangunter opened this issue Dec 18, 2024 · 0 comments · May be fixed by #137
Assignees
Labels
documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR

Comments

@dangunter
Copy link
Member

Hello,

We are announcing the deprecation of projects using Sphinx or MkDocs without an explicit configuration in their .readthedocs.yaml file. After January 20, 2025, Read the Docs will require explicit configuration for all Sphinx and MkDocs projects.

We used to automatically try to find the configuration file for your project, but in order to make builds more explicit and predictable, we are deprecating this behavior. This will also allows us to better support projects that don't use Sphinx or MkDocs in the near future.
What do I need to do?

If you're using Sphinx or MkDocs, ensure your .readthedocs.yaml file includes the appropriate configuration key. For example:

For Sphinx projects:

version: 2
sphinx:
configuration: docs/conf.py

For MkDocs projects:

version: 2
mkdocs:
configuration: mkdocs.yml

Note: If you're using build.commands, no changes are required.
Deprecation timeline

We will implement this change gradually:

January 6, 2025: Builds will be temporarily disabled for 12 hours (00:01 PST to 11:59 PST)
January 13, 2025: Builds will be temporarily disabled for 24 hours (00:01 PST to 23:59 PST)
January 20, 2025: Final cutoff date - builds without explicit configuration will be permanently disabled

Are my projects affected?

We found the following projects where you are a maintainer that may be impacted by this change:

[idaes-examples](https://readthedocs.org/projects/idaes-examples/)
@dangunter dangunter added the documentation Improvements or additions to documentation label Dec 18, 2024
@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Dec 19, 2024
@mrmundt mrmundt linked a pull request Dec 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants