-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
title: Stop manipulating `mkdocs.yml` | ||
date: 2024-03-25 | ||
category: Changelog | ||
tags: builders, deprecation, mkdocs, addons | ||
authors: Manuel Kaufmann | ||
status: published | ||
image: /images/mkdocs-yaml-manipulation.jpg | ||
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> | ||
|
||
|
||
We are announcing the deprecation of the `mkdocs.yml` manipulation done by Read the Docs at build time on **Monday, April 15th, 2024**. | ||
After this date, there will be some changes in the behavior: | ||
|
||
* MkDocs default theme will be used if your documentation is not defining one on its `mkdocs.yml` file. | ||
If you want to continue using the `readthedocs` theme, read [Choosing your Theme](https://www.mkdocs.org/user-guide/choosing-your-theme/) MkDocs' documentation | ||
to learn how to explicity define it in the configuration file. | ||
* [The new beta Read the Docs Addons](https://blog.readthedocs.com/addons-flyout-menu-beta/) will be enabled by default. | ||
|
||
|
||
We've made this decision towards a simplification of the build process executed on Read th Docs, | ||
allowing our users to get the same results when building their documentation locally and on our platform. | ||
Besides, this simplification allows more complex configuration in the YAML by using the special `!!` syntax | ||
[that wasn't supported due to security reasons](https://github.com/readthedocs/readthedocs.org/issues/8529). | ||
|
||
|
||
[Contact us](https://readthedocs.org/support/) if you have any questions, | ||
and let us know any inconvenient you may have with this change. |