-
Notifications
You must be signed in to change notification settings - Fork 49
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
Read the Docs deprecation #731
Comments
Here's the email notification we got from Read the Docs. [Action required] Make sure your project is compatible with MkDocs >= 1.xHello, You are receving this email because your Read the Docs project is impacted by an upcoming deprecation. Historically, Read the Docs has installed MkDocs 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 python:
install:
- requirements: docs/requirements.txt The content of
We are sending you this email because you are a maintainer of the following projects that are affected by this removal: Read more about this in our Reproducible builds guide for more details. Keep documenting, Read the Docs |
@pooja1pathak's #771 updated the MkDocs build. Let's check it works on ReadTheDocs too before closing this issue. |
@c0c0n3 As per my knowledge we need to execute |
@pooja1pathak I've just triggered a fresh build on ReadTheDocs and it worked like a charm, thanks so much! |
Is your feature request related to a problem? Please describe.
Read the Docs are upgrading their builder. This could break our doc gen pipeline and produce garbage in the online docs.
Describe the solution you'd like
Either upgrade to the latest Read the Docs or pin the version. Ideally we should upgrade, well as long as it doesn't turn out to be a massive amount of work, in which case we could just pin the MkDocs version for now.
Describe alternatives you've considered
N/A
Additional context
See email below from Read the Docs.
The text was updated successfully, but these errors were encountered: