Deprecation of projects using Sphinx or MkDocs without an explicit configuration in their .readthedocs.yaml file #136
Labels
documentation
Improvements or additions to documentation
Priority:Normal
Normal Priority Issue or PR
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:
Are my projects affected?
We found the following projects where you are a maintainer that may be impacted by this change:
The text was updated successfully, but these errors were encountered: