From 735e39b46b33f5e2cbd0609d9aa6859f6e244382 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Thu, 19 Oct 2023 12:09:53 -0500 Subject: [PATCH 1/3] Docs: update docs about default dependencies --- docs/user/build-default-versions.rst | 42 ++++------------------------ 1 file changed, 5 insertions(+), 37 deletions(-) diff --git a/docs/user/build-default-versions.rst b/docs/user/build-default-versions.rst index ab59e1064df..a440a207a4c 100644 --- a/docs/user/build-default-versions.rst +++ b/docs/user/build-default-versions.rst @@ -15,11 +15,9 @@ Read the Docs supports two tools to build your documentation: In order to provide :doc:`several features `, Read the Docs injects or modifies some content while building your docs. -In particular, if you don't specify the dependencies of your project, -we install some of them on your behalf. -In the past we used to pin these dependencies to a specific version and update them after some time, +In the past we used to install several dependencies to a specific version and update them after some time, but doing so would break some builds and make it more difficult for new projects to use new versions. -For this reason, we are now installing their latest version by default. +For this reason, we are now installing just the minimal required dependencies using their latest version by default. .. note:: @@ -36,46 +34,16 @@ Python These are the dependencies that are installed by default when using a Python environment: Sphinx: - Projects created before Oct 20, 2020 use ``1.8.x``. - New projects use the latest version. + Latest version by default. Mkdocs: - Projects created before April 3, 2019 (April 23, 2019 for :doc:`/commercial/index`) use ``0.17.3``. - New projects use the latest version. - -sphinx-rtd-theme: - Projects created before October 20, 2020 (January 21, 2021 for :doc:`/commercial/index`) use ``0.4.3``. - New projects use the latest version. - Projects created after August 7, 2023 won't install this dependency by default. + Latest version by default. pip: Latest version by default. setuptools: - Projects using ``setup.py install`` as installation method use ``58.2.0`` or older. - All other projects use the latest version. - Projects created after August 7, 2023 will always use the latest version. - -mock: - ``1.0.1``. - Projects created after August 7, 2023 won't install this dependency by default. - - -pillow: - ``5.4.1`` when using Python 2.7, 3.4, 3.5, 3.6, 3.7. Otherwise, its latest version. - Projects created after August 7, 2023 won't install this dependency by default. - -alabaster: - ``0.7.x``. - Projects created after August 7, 2023 won't install this dependency by default. - -commonmark: - ``0.8.1``. - Projects created after August 7, 2023 won't install this dependency by default. - -recommonmark: - ``0.5.0``. - Projects created after August 7, 2023 won't install this dependency by default. + Latest version by default. Conda ~~~~~ From 9b1a312c1551622b8a28988f8d0a5d56c50fd08f Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 23 Oct 2023 07:30:42 -0500 Subject: [PATCH 2/3] Update docs/user/build-default-versions.rst Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/user/build-default-versions.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/build-default-versions.rst b/docs/user/build-default-versions.rst index a440a207a4c..e6ab920d8c5 100644 --- a/docs/user/build-default-versions.rst +++ b/docs/user/build-default-versions.rst @@ -18,6 +18,7 @@ Read the Docs injects or modifies some content while building your docs. In the past we used to install several dependencies to a specific version and update them after some time, but doing so would break some builds and make it more difficult for new projects to use new versions. For this reason, we are now installing just the minimal required dependencies using their latest version by default. +You can see the full list of historical dependencies and advice for migrating in our `blog post `_ announcing this change. .. note:: From 871af1826b6893bc42d48384a18a9653e966d74b Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 23 Oct 2023 07:31:03 -0500 Subject: [PATCH 3/3] Update docs/user/build-default-versions.rst --- docs/user/build-default-versions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/build-default-versions.rst b/docs/user/build-default-versions.rst index e6ab920d8c5..4272ac62c8f 100644 --- a/docs/user/build-default-versions.rst +++ b/docs/user/build-default-versions.rst @@ -18,7 +18,7 @@ Read the Docs injects or modifies some content while building your docs. In the past we used to install several dependencies to a specific version and update them after some time, but doing so would break some builds and make it more difficult for new projects to use new versions. For this reason, we are now installing just the minimal required dependencies using their latest version by default. -You can see the full list of historical dependencies and advice for migrating in our `blog post `_ announcing this change. +You can see the full list of historical dependencies and advice for migrating in our `blog post `__ announcing this change. .. note::