Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update read the docs based on email for MkDocs  #82

Open
jpsider opened this issue Aug 9, 2023 · 0 comments
Open

update read the docs based on email for MkDocs  #82

jpsider opened this issue Aug 9, 2023 · 0 comments

Comments

@jpsider
Copy link
Owner

jpsider commented Aug 9, 2023

Hello,

You are receving this email because your Read the Docs project is impacted by an upcoming deprecation.Historically, Read the Docs has installed MkDocs 0.17.3 by default if the project didn't define a specific version of it. Now, this version is a pretty old and we recommend our users to use the latest version of MkDocs: 1.5.1.To avoid failing builds we kept the old default version of MkDocs. 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.Starting on October 3rd Read the Docs will install the latest available version of MkDocs. If you want to use a different version, make sure you are pinning your MkDocs dependency.Here you have a pretty simple example of the section required on the .readthedocs.yaml configuration file:python: install: - requirements: docs/requirements.txt The content of docs/requirements.txt would be similar to:mkdocs==1.5.1 We are sending you this email because you are a maintainer of the following projects that are affected by this removal:restpsRead more about this in our Reproducible builds guide for more details.
Keep documenting,Read the Docs

Hello, You are receving this email because your Read the Docs project is impacted by an upcoming deprecation.

Historically, Read the Docs has installed MkDocs 0.17.3 by default if the project didn't define a specific version of it. Now, this version is a pretty old and we recommend our users to use the latest version of MkDocs: 1.5.1.

To avoid failing builds we kept the old default version of MkDocs. 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.

Starting on October 3rd Read the Docs will install the latest available version of MkDocs. If you want to use a different version, make sure you are pinning your MkDocs dependency.

Here you have a pretty simple example of the section required on the .readthedocs.yaml configuration file:

python:
install:
- requirements: docs/requirements.txt
The content of docs/requirements.txt would be similar to:

mkdocs==1.5.1
We are sending you this email because you are a maintainer of the following projects that are affected by this removal:

restps
Read more about this in our Reproducible builds guide for more details.

Keep documenting,
Read the Docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant