Deprecation: remove support for Sphinx 1.x #10365
Conversation
We are installing Sphinx 1.x based on a feature flag. There are around 900 projects still using 1.x, based on https://ethicalads.metabaseapp.com/question/250-projects-using-sphinx-timeserie Note this feature flag is enabled by default for new projects starting on Oct. 20, 2020 We may need to send them an email about this and informing them how to create a `requirements.txt` file to pin their dependencies. I don't think that the migration to a config file v2 would enforce them to pin Sphinx. Related #10342
|
Strong 👍 on this deprecation, but we definitely need to email them, and do a proper deprecation timeline for this. I'm fine with the same timeline as the config file, if that makes things easier? |
Small changelog blog post to communicate we are deprecating installing Sphinx 1.x automatically for projects created before Oct 20, 2020. Besides, the blog post briefly describes how to create a `requirements.txt` file and how to update the `.readthedocs.yaml` to install them. This is aligned with the deprecation of building without a config file. We are using the same timeline for both. The code removal of this feature flag is done at readthedocs/readthedocs.org#10365
Small changelog blog post to communicate we are deprecating installing Sphinx 1.x automatically for projects created before Oct 20, 2020. Besides, the blog post briefly describes how to create a `requirements.txt` file and how to update the `.readthedocs.yaml` to install them. This is aligned with the deprecation of building without a config file. We are using the same timeline for both. The code removal of this feature flag is done at readthedocs/readthedocs.org#10365
Small changelog blog post to communicate we are deprecating installing Sphinx 1.x automatically for projects created before Oct 20, 2020. Besides, the blog post briefly describes how to create a `requirements.txt` file and how to update the `.readthedocs.yaml` to install them. This is aligned with the deprecation of building without a config file. We are using the same timeline for both. The code removal of this feature flag is done at readthedocs/readthedocs.org#10365
Small changelog blog post to communicate we are deprecating installing Sphinx 1.x automatically for projects created before Oct 20, 2020. Besides, the blog post briefly describes how to create a `requirements.txt` file and how to update the `.readthedocs.yaml` to install them. This is aligned with the deprecation of building without a config file. We are using the same timeline for both. The code removal of this feature flag is done at readthedocs/readthedocs.org#10365
|
I started writing a simple blog post about this as well, readthedocs/blog#220. We can write a minimal email pointing to this blog post once it's published. |
|
This is blocked on communication efforts. |
|
Starting next week, August 7th, we will be installing the latest version of all the core requirements for new projects: https://blog.readthedocs.com/python-core-requirements-changed/ What about the following plan to follow here?
During the deprecation dates, users will need to:
At this point all the projects will have a configuration file and their required dependencies pinned. @ericholscher anything else here to consider that I may be missing? |
|
@humitos I think this makes sense, but I'm getting a bit lost with all the deprecations! Do we have a place we're tracking them all together, similar to the feature flag deprecations? |
Me too 😅 . I've merged PRs that I shouldn't because of these confusions 😄
I opened #10587 to track them. |
I found only 24 doing a more specific query 🎉 SELECT DISTINCT data->'project'->>'slug' as slug
FROM
"telemetry_builddata"
WHERE
data @? '$.packages.pip.all ? (@.name == "sphinx" && @.version == "1.8.6")'
ORDER BY slug ASC |
|
@stsewd @ericholscher this is review for review and merge. We should merge it before deploying next week due to https://blog.readthedocs.com/defaulting-latest-build-tools/ |
We are installing Sphinx 1.x based on a feature flag. There are around ~900 projects still using 1.x, based on https://ethicalads.metabaseapp.com/question/250-projects-using-sphinx-timeserie
Note this feature flag is enabled by default for new projects starting on Oct. 20, 2020
We may need to send them an email about this and informing them how to create a
requirements.txtfile to pin their dependencies. I don't think that the migration to a config file v2 would enforce them to pin Sphinx.Related #10342