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

Read the Docs deprecation #731

Open
c0c0n3 opened this issue Aug 3, 2023 · 1 comment
Open

Read the Docs deprecation #731

c0c0n3 opened this issue Aug 3, 2023 · 1 comment
Assignees

Comments

@c0c0n3
Copy link
Member

c0c0n3 commented Aug 3, 2023

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.

@c0c0n3 c0c0n3 self-assigned this Aug 3, 2023
@c0c0n3
Copy link
Member Author

c0c0n3 commented Aug 3, 2023

Here's the email notification we got from Read the Docs.

[Action required] Make sure your project is compatible with MkDocs >= 1.x

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:

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
Projects
None yet
Development

No branches or pull requests

1 participant