Skip to content

Commit c9360b6

Browse files
Post: MkDocs YAML manipulation (#277)
* Post: MkDocs YAML manipulation Blog post announcing the depreaction of the `mkdocs.yml` manipulation done by Read the Docs at build time, following the plan described. Related: * readthedocs/addons#72 (comment) * readthedocs/readthedocs.org#11206 * readthedocs/readthedocs.org#8529 * Use double quotes The other ones don't render properly. * Apply suggestions from code review Co-authored-by: Eric Holscher <[email protected]> --------- Co-authored-by: Eric Holscher <[email protected]>
1 parent a776aad commit c9360b6

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed
108 KB
Loading
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
title: Build process change: removing changes to mkdocs.yml
2+
date: 2024-03-25
3+
category: Changelog
4+
tags: builders, deprecation, mkdocs, addons
5+
authors: Manuel Kaufmann
6+
status: published
7+
image: /images/mkdocs-yaml-manipulation.jpg
8+
image_credit: Photo by <a href="https://unsplash.com/@flowforfrank?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Ferenc Almasi</a> on <a href="https://unsplash.com/photos/text-yXrl2lkGJ-k?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>
9+
10+
11+
We are announcing the deprecation of the `mkdocs.yml` manipulation done by Read the Docs at build time on **Monday, April 15th, 2024**.
12+
After this date, there will be some changes in build process behavior:
13+
14+
* MkDocs default theme will be used if your documentation is not defining one on its `mkdocs.yml` file.
15+
If you want to continue using the `readthedocs` theme, read [Choosing your Theme](https://www.mkdocs.org/user-guide/choosing-your-theme/) MkDocs' documentation
16+
to learn how to explicity define it in the configuration file.
17+
* [The new beta Read the Docs Addons](https://blog.readthedocs.com/addons-flyout-menu-beta/) will be enabled by default.
18+
19+
20+
We've made this decision to simplify the build process executed on Read the Docs,
21+
allowing our users to get the same results when building their documentation locally and on our platform.
22+
This simplification allows more complex configuration in the YAML by using the special `!!` syntax
23+
[that wasn't previously supported due to security reasons](https://github.com/readthedocs/readthedocs.org/issues/8529).
24+
25+
26+
[Contact us](https://readthedocs.org/support/) if you have any questions,
27+
and let us know any inconvenient you may have with this change.

0 commit comments

Comments
 (0)