Skip to content

Commit e324148

Browse files
committed
Post: Drop support for MkDocs 0.17.3
Announcement of readthedocs/readthedocs.org#10584
1 parent a05e582 commit e324148

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

drop-support-for-mkdocs-0-17-3.rst

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. post:: August 2, 2023
2+
:tags: builders
3+
:author: Manuel
4+
:location: BCN
5+
:category: Changelog
6+
7+
Drop support for MkDocs 0.17.3
8+
==============================
9+
10+
Historically, Read the Docs has installed MkDocs ``0.17.3`` by default if the project didn't define a specific version of it.
11+
Now, this version is a pretty old and we recommend our users to use the latest version of MkDocs. Currently, ``1.5.1``.
12+
13+
To avoid failing builds of projects using the version installed by default if we upgrade to the latest MkDocs version available,
14+
we kept installing the old one during all this time.
15+
Now, *we are changing that behavior to always install the latest available version* and we wanted to let you know about that so you can prepare your project.
16+
17+
**Starting on September 5th Read the Docs will install the latest available version of MkDocs**.
18+
If you want to use a different version, make sure you are pinning your MkDocs dependency.
19+
20+
Here you have a pretty simple example of the section required on the `.readthedocs.yaml` configuration file:
21+
22+
.. code-block:: yaml
23+
24+
# ... snip ...
25+
26+
python:
27+
install:
28+
- requirements: docs/requirements.txt
29+
30+
# ... snip ...
31+
32+
The content of `docs/requirements.txt` would be similar to::
33+
34+
mkdocs==1.5.1
35+
36+
Read more about this in our `Reproducible builds <https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html>`_ guide for more details.

0 commit comments

Comments
 (0)