Skip to content

Commit 15f43b3

Browse files
committed
Post: deprecate config files without sphinx or mkdocs configuration
Ref: - readthedocs/readthedocs.org#10637 - readthedocs/readthedocs.org#11819
1 parent af77787 commit 15f43b3

2 files changed

+41
-0
lines changed
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
title: Deprecation of configuration files without Sphinx or MkDocs configuration
2+
date: December 16, 2024
3+
description: Announcing the deprecation of configuration files without Sphinx or MkDocs configuration.
4+
category: Changelog
5+
tags: deprecation, configuration-file
6+
authors: Santos Gallegos
7+
status: published
8+
image: /images/deprecated-config-file-without-sphinx-or-mkdocs-config.jpg
9+
image_credit: Photo by <a href="https://unsplash.com/@jernejgraj?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Jernej Graj</a> on <a href="https://unsplash.com/photos/photo-of-seashore-during-golden-hour-n44KHcbp1_E?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>
10+
11+
We are announcing the deprecation of configuration files that do not contain a explicit `sphinx` or `mkdocs` configuration.
12+
13+
If your `.readthedocs.yaml` configuration file doesn't contain a `sphinx.configuration` or `mkdocs.configuration` key,
14+
make sure to add it. For example, for a Sphinx project, your configuration file should look like this:
15+
16+
```yaml
17+
version: 2
18+
sphinx:
19+
# Path to your Sphinx configuration file.
20+
configuration: docs/conf.py
21+
```
22+
23+
For a MkDocs project, your configuration file should look like this:
24+
25+
```yaml
26+
version: 2
27+
mkdocs:
28+
# Path to your MkDocs configuration file.
29+
configuration: mkdocs.yml
30+
```
31+
32+
We used to automatically try to find the configuration file for your project,
33+
but in order to make builds more explicit and predictable, we are deprecating this behavior.
34+
This will also allows us to better support projects that don't use Sphinx or MkDocs in the near future.
35+
36+
Deprecation timeline
37+
--------------------
38+
39+
- **Monday, January 6, 2024**: Temporarily disallow projects without an explicit Sphinx or MkDocs configuration for 12 hours, from 00:01 PST to 11:59 PST.
40+
- **Monday, January 20, 2025**:Temporarily disallow projects without an explicit Sphinx or MkDocs configuration for 24 hours, from 00:01 PST to 23:59 PST.
41+
- **Monday, February 3, 2025**: Permanently disallow projects without an explicit Sphinx or MkDocs configuration.

0 commit comments

Comments
 (0)