From 6fdf2304e4dfa8a7cac131559c100a10ea8a76dd Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Thu, 21 Jan 2021 19:27:55 -0500 Subject: [PATCH 01/14] Docs: policy for supported tools and dependencies --- docs/index.rst | 2 + docs/supported-tools.rst | 140 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 142 insertions(+) create mode 100644 docs/supported-tools.rst diff --git a/docs/index.rst b/docs/index.rst index 10140ba7601..f4f1b03c47e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -201,6 +201,7 @@ of Read the Docs and the larger software documentation ecosystem. :doc:`Terms of service ` | :doc:`DMCA takedown policy ` | :doc:`Policy for abandoned projects ` | + :doc:`/supported-tools` | :doc:`Release notes & changelog ` * **The people and philosophy behind Read the Docs**: @@ -236,6 +237,7 @@ of Read the Docs and the larger software documentation ecosystem. terms-of-service dmca/index abandoned-projects + supported-tools changelog about diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst new file mode 100644 index 00000000000..a5cc3cfd567 --- /dev/null +++ b/docs/supported-tools.rst @@ -0,0 +1,140 @@ +Supported Tools and Dependencies +================================ + +Currently, Read the Docs supports two tools to build your documentation: Sphinx and MkDocs. +In order to provide :doc:`several features `, +Read the Docs needs to inject or modify some content while building your docs. + +When an incompatible change happens in one of these tools or dependencies, +we need to change our code as well to keep our features working, +this is done with backwards compatibility in mind. + +But sometimes is hard to keep compatibility with old and new versions at the same time, +so in order to continue moving forward on future development and features we need to drop support for some versions. + +.. note:: + + Your existent documentation will always be kept online and working, + But **when support for a tool or dependency ends, new builds may fail**. + +End of support policy +--------------------- + +Our policy defines how long a given tool or dependency is considered supported. +After it reaches its end of support date, +we don't offer support for builds/docs using these tools or dependencies, +you'll need to upgrade in order to receive support. +For :doc:`/commercial/index` we provide an extended support of 6 months after the end of support date. + +.. note:: + + Some recent versions may be supported, but aren't listed on this table + (specially minor updates from supported versions), + contact us if you have doubts. + +Sphinx +------ + +.. list-table:: + :header-rows: 1 + + * - Version + - Released + - Supported Until + + * - 3.0.0 - 3.4.x + - Apr 5, 2020 - Jan 7, 2021 + - 5.0 is released or early + + * - 2.0.0 - 2.4.4 + - Mar 28, 2019 - Mar 5 , 2020 + - 4.0 is released or early + + * - 1.8.0 - 1.8.x + - Sep 12, 2018 - Mar 10, 2019 + - Nov 31, 2021 + + * - 1.6.0 - 1.7.9 + - May 28, 2017 - Sep 5, 2018 + - Nov 31, 2021 + + * - 0.1 - 1.5.6 + - Mar 21, 2008 - May 14, 2017 + - Unsupported + + +Sphinx_ releases its versions incrementally. + +.. _Sphinx: https://www.sphinx-doc.org/ + +Mkdocs +------ + +.. list-table:: + :header-rows: 1 + + * - Version + - Released + - Supported Until + + * - 1.0 - 1.1.2 + - Aug 3, 2018 - May 14, 2020 + - 3.0 released or early + + * - 0.17.4 - 0.17.5 + - Jun 8, 2018 - Jul 6, 2018 + - Mar 31, 2022 + + * - 0.17.0 - 0.17.3 + - Oct 19, 2017 - Mar 7, 2018 + - Nov 31, 2021 + + * - 0.1 - 0.16.3 + - Jan 11, 2014 - Apr 4, 2017 + - Unsupported + +MkDocs_ releases its versions incrementally. + +.. _MkDocs: https://www.mkdocs.org/ + +Python +------ + +Python_ defines an EOL (End Of Life) date for all its versions. + +.. _Python: https://www.python.org/ + +.. list-table:: + :header-rows: 1 + + * - Version + - EOL Date + - Supported Until + + * - 3.10 (not available yet) + - ? + - ? + + * - 3.9 (not available yet) + - Oct 05, 2025 + - Dec 31, 2025 + + * - 3.8 + - Oct 14, 2024 + - Dec 31, 2024 + + * - 3.7 + - Jun 27, 2023 + - Sep 31, 2023 + + * - 3.6 + - Dec 23, 2021 + - Jan 31, 2022 + + * - 3.5 + - Sep 13, 2020 + - Nov 31, 2021 + + * - 2.7 + - Jan 01, 2020 + - Nov 31, 2021 From d45437620b78403dda7e8ad5775b7d032658d722 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 25 Jan 2021 15:02:08 -0500 Subject: [PATCH 02/14] Update --- docs/Makefile | 4 +- docs/supported-tools.rst | 197 +++++++++++++++++++++++++++++---------- 2 files changed, 152 insertions(+), 49 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index cdb357b38f7..e05fbd3d276 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = -W +SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build @@ -63,7 +63,7 @@ html: @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." livehtml: - sphinx-autobuild -p 4444 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + sphinx-autobuild --port 4444 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html dirhtml: diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index a5cc3cfd567..b4ebdef9f33 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -1,7 +1,7 @@ Supported Tools and Dependencies ================================ -Currently, Read the Docs supports two tools to build your documentation: Sphinx and MkDocs. +Read the Docs supports two tools to build your documentation: Sphinx_ and MkDocs_. In order to provide :doc:`several features `, Read the Docs needs to inject or modify some content while building your docs. @@ -17,6 +17,13 @@ so in order to continue moving forward on future development and features we nee Your existent documentation will always be kept online and working, But **when support for a tool or dependency ends, new builds may fail**. +.. _Sphinx: https://www.sphinx-doc.org/ +.. _MkDocs: https://www.mkdocs.org/ + +.. contents:: Contents + :local: + :depth: 3 + End of support policy --------------------- @@ -24,81 +31,181 @@ Our policy defines how long a given tool or dependency is considered supported. After it reaches its end of support date, we don't offer support for builds/docs using these tools or dependencies, you'll need to upgrade in order to receive support. -For :doc:`/commercial/index` we provide an extended support of 6 months after the end of support date. +For :doc:`/commercial/index` we provide an extended support of six after the official end of support date. + +For tools that define an EOL date, we try to follow that date for our policy. +For tools that release their versions incrementally without an EOL date, +we choose a date based on the release of mayor versions (versions with breaking changes), +the date since it was last updated, and its usage on our platform. .. note:: - Some recent versions may be supported, but aren't listed on this table + Some recent versions may be supported, but aren't listed on these tables (specially minor updates from supported versions), contact us if you have doubts. +Default dependencies +-------------------- + +We install some dependencies by default in order to build your project. +In the past we used to pin these dependencies to a specific version and update them after some time, +but when doing so, some builds could break. +For this reason we are now installing their latest version (or latest supported version) by default. + +External dependencies (Python) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sphinx: + Projects created before Oct 20, 2020 will use ``1.8.x``. + New projects use the latest version. + +Mkdocs: + Projects created before April 3, 2019 will use ``0.17.3``. + New projects use the latest version. + +sphinx-rtd-theme: + Projects created before Oct 20, 2020 will use ``0.4.3``. + New projects use the latest version. + +pip: + Latest version by default. + +setuptools: + Latest version by default. + +six: + Latest version by default (could be removed in the future). + +mock: + ``1.0.1`` (could be removed in the future). + +pillow: + ``5.4.1`` (could be removed in the future). + +alabaster: + ``0.7.x`` (could be removed in the future). + +commonmark: + ``0.8.1`` (could be removed in the future). + +recommonmark: + ``0.5.0`` (could be removed in the future). + +.. note:: + + In order to keep your builds reproducible, + we highly recommend pinning all of your dependencies. + + .. TODO: link to this guide once it's written https://github.com/readthedocs/readthedocs.org/issues/7852. + +External dependencies (Conda) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Conda: + Miniconda2 ``4.6.14`` + (could be updated to use the latest version by default). + +Mkdocs: + Latest version by default installed via ``conda``. + +Sphinx: + Latest version by default installed via ``conda``. + +sphinx-rtd-theme: + Latest version by default installed via ``conda``. + +mock: + Latest version by default installed via ``pip`` (could be removed in the future). + +pillow: + Latest version by default installed via ``pip`` (could be removed in the future). + +recommonmark: + Latest version by default installed via ``conda`` (could be removed in the future). + +six: + Latest version by default installed via ``conda`` (could be removed in the future). + + +Internal dependencies +~~~~~~~~~~~~~~~~~~~~~ + +Internal dependencies are needed to integrate your docs with Read the Docs. +We guarantee that these dependencies will work with all current supported versions of our tools, +you don't need to specify or pinning them. + +readthedocs-sphinx-ext: + ``2.1.x`` for Python projects, latest version for Conda projects. + +Table of supported versions +--------------------------- + Sphinx ------- +~~~~~~ + +Sphinx releases its versions incrementally. .. list-table:: :header-rows: 1 * - Version - - Released + - Released / Latest Update - Supported Until - * - 3.0.0 - 3.4.x - - Apr 5, 2020 - Jan 7, 2021 + * - ``3.x`` + - Apr 5, 2020 / ??? - 5.0 is released or early - * - 2.0.0 - 2.4.4 - - Mar 28, 2019 - Mar 5 , 2020 + * - ``2.x`` + - Mar 28, 2019 / Mar 5, 2020 - 4.0 is released or early - * - 1.8.0 - 1.8.x - - Sep 12, 2018 - Mar 10, 2019 + * - ``1.8.x`` + - Sep 12, 2018 / Mar 10, 2019 - Nov 31, 2021 - * - 1.6.0 - 1.7.9 - - May 28, 2017 - Sep 5, 2018 + * - ``1.7.x`` + - Feb 12, 2018 / Sep 5, 2018 - Nov 31, 2021 - * - 0.1 - 1.5.6 - - Mar 21, 2008 - May 14, 2017 - - Unsupported - - -Sphinx_ releases its versions incrementally. + * - ``1.6.x`` + - May 16, 2017 / Feb 4, 2017 + - Nov 31, 2021 -.. _Sphinx: https://www.sphinx-doc.org/ + * - ``<= 1.5.x`` + - Mar 21, 2008 / May 14, 2017 + - Unsupported Mkdocs ------- +~~~~~~ + +MkDocs releases its versions incrementally. .. list-table:: :header-rows: 1 * - Version - - Released + - Released / Latest Update - Supported Until - * - 1.0 - 1.1.2 - - Aug 3, 2018 - May 14, 2020 + * - ``1.1.x`` + - Feb 22, 2020 / ??? - 3.0 released or early - * - 0.17.4 - 0.17.5 - - Jun 8, 2018 - Jul 6, 2018 - - Mar 31, 2022 + * - ``1.0.x`` + - Aug 3, 2018 / Sep 17, 2018 + - 2.0 released or early - * - 0.17.0 - 0.17.3 - - Oct 19, 2017 - Mar 7, 2018 + * - ``0.17.x`` + - Oct 19, 2017 / Jul 6, 2018 - Nov 31, 2021 - * - 0.1 - 0.16.3 - - Jan 11, 2014 - Apr 4, 2017 + * - ``<= 0.16.x`` + - Jan 11, 2014 / Apr 4, 2017 - Unsupported - -MkDocs_ releases its versions incrementally. - -.. _MkDocs: https://www.mkdocs.org/ Python ------- +~~~~~~ Python_ defines an EOL (End Of Life) date for all its versions. @@ -111,30 +218,26 @@ Python_ defines an EOL (End Of Life) date for all its versions. - EOL Date - Supported Until - * - 3.10 (not available yet) - - ? - - ? - - * - 3.9 (not available yet) + * - ``3.9.x`` (not available yet) - Oct 05, 2025 - Dec 31, 2025 - * - 3.8 + * - ``3.8.x`` - Oct 14, 2024 - Dec 31, 2024 - - * - 3.7 + + * - ``3.7.x`` - Jun 27, 2023 - Sep 31, 2023 - * - 3.6 + * - ``3.6.x`` - Dec 23, 2021 - Jan 31, 2022 - * - 3.5 + * - ``3.5.x`` - Sep 13, 2020 - Nov 31, 2021 - * - 2.7 + * - ``2.7.x`` - Jan 01, 2020 - Nov 31, 2021 From be3b0b78613413b63d247725dbcfc33b3a74d3be Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 25 Jan 2021 18:08:35 -0500 Subject: [PATCH 03/14] More updates --- docs/supported-tools.rst | 97 +++++++++++++++++++++------------------- 1 file changed, 50 insertions(+), 47 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index b4ebdef9f33..0fd874ee0c0 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -1,25 +1,22 @@ Supported Tools and Dependencies ================================ -Read the Docs supports two tools to build your documentation: Sphinx_ and MkDocs_. +Read the Docs supports two tools to build your documentation: +`Sphinx `__ and `MkDocs `__. In order to provide :doc:`several features `, Read the Docs needs to inject or modify some content while building your docs. When an incompatible change happens in one of these tools or dependencies, we need to change our code as well to keep our features working, this is done with backwards compatibility in mind. - But sometimes is hard to keep compatibility with old and new versions at the same time, -so in order to continue moving forward on future development and features we need to drop support for some versions. +in order to continue moving forward on future development and features we need to drop support for some versions. .. note:: Your existent documentation will always be kept online and working, But **when support for a tool or dependency ends, new builds may fail**. -.. _Sphinx: https://www.sphinx-doc.org/ -.. _MkDocs: https://www.mkdocs.org/ - .. contents:: Contents :local: :depth: 3 @@ -31,11 +28,11 @@ Our policy defines how long a given tool or dependency is considered supported. After it reaches its end of support date, we don't offer support for builds/docs using these tools or dependencies, you'll need to upgrade in order to receive support. -For :doc:`/commercial/index` we provide an extended support of six after the official end of support date. +For :doc:`/commercial/index` we provide an extended support of six months after the official end of support date. For tools that define an EOL date, we try to follow that date for our policy. For tools that release their versions incrementally without an EOL date, -we choose a date based on the release of mayor versions (versions with breaking changes), +we choose a date based on: the release of mayor versions (versions with breaking changes), the date since it was last updated, and its usage on our platform. .. note:: @@ -47,24 +44,33 @@ the date since it was last updated, and its usage on our platform. Default dependencies -------------------- -We install some dependencies by default in order to build your project. -In the past we used to pin these dependencies to a specific version and update them after some time, -but when doing so, some builds could break. +We install some dependencies in order to build your project without specifying their dependencies. +In the past we used to set these dependencies to a specific version and update them after some time, +but by doing so would break some builds and new projects wouldn't be able to use a new version by default. For this reason we are now installing their latest version (or latest supported version) by default. +.. note:: + + In order to keep your builds reproducible, + it's highly recommended declaring its dependencies and versions explicitly. + + .. TODO: link to this guide once it's written https://github.com/readthedocs/readthedocs.org/issues/7852. + External dependencies (Python) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +These are the dependencies that are installed by default when using a Python environment: + Sphinx: - Projects created before Oct 20, 2020 will use ``1.8.x``. + Projects created before Oct 20, 2020 use ``1.8.x``. New projects use the latest version. Mkdocs: - Projects created before April 3, 2019 will use ``0.17.3``. + Projects created before April 3, 2019 use ``0.17.3``. New projects use the latest version. sphinx-rtd-theme: - Projects created before Oct 20, 2020 will use ``0.4.3``. + Projects created before Oct 20, 2020 use ``0.4.3``. New projects use the latest version. pip: @@ -73,9 +79,6 @@ pip: setuptools: Latest version by default. -six: - Latest version by default (could be removed in the future). - mock: ``1.0.1`` (could be removed in the future). @@ -91,16 +94,11 @@ commonmark: recommonmark: ``0.5.0`` (could be removed in the future). -.. note:: - - In order to keep your builds reproducible, - we highly recommend pinning all of your dependencies. - - .. TODO: link to this guide once it's written https://github.com/readthedocs/readthedocs.org/issues/7852. - External dependencies (Conda) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +These are the dependencies that are installed by default when using a Conda environment: + Conda: Miniconda2 ``4.6.14`` (could be updated to use the latest version by default). @@ -123,19 +121,14 @@ pillow: recommonmark: Latest version by default installed via ``conda`` (could be removed in the future). -six: - Latest version by default installed via ``conda`` (could be removed in the future). - - Internal dependencies ~~~~~~~~~~~~~~~~~~~~~ Internal dependencies are needed to integrate your docs with Read the Docs. We guarantee that these dependencies will work with all current supported versions of our tools, -you don't need to specify or pinning them. +you don't need to specify them in your requirements. -readthedocs-sphinx-ext: - ``2.1.x`` for Python projects, latest version for Conda projects. +- readthedocs-sphinx-ext Table of supported versions --------------------------- @@ -154,26 +147,30 @@ Sphinx releases its versions incrementally. * - ``3.x`` - Apr 5, 2020 / ??? - - 5.0 is released or early + - 5.0 is released or later/early * - ``2.x`` - Mar 28, 2019 / Mar 5, 2020 - - 4.0 is released or early + - 4.0 is released or later/early * - ``1.8.x`` - Sep 12, 2018 / Mar 10, 2019 - - Nov 31, 2021 + - Nov 31, 2022 * - ``1.7.x`` - Feb 12, 2018 / Sep 5, 2018 - - Nov 31, 2021 + - Nov 31, 2022 * - ``1.6.x`` - May 16, 2017 / Feb 4, 2017 - Nov 31, 2021 - * - ``<= 1.5.x`` - - Mar 21, 2008 / May 14, 2017 + * - ``1.5.x`` + - Dec 5, 2016 / May 4, 2017 + - Nov 31, 2021 + + * - ``<= 1.4.x`` + - Mar 21, 2008 / Nov 23, 2016 - Unsupported Mkdocs @@ -190,26 +187,32 @@ MkDocs releases its versions incrementally. * - ``1.1.x`` - Feb 22, 2020 / ??? - - 3.0 released or early + - 3.0 released or later/early * - ``1.0.x`` - Aug 3, 2018 / Sep 17, 2018 - - 2.0 released or early + - 2.0 released or later/early * - ``0.17.x`` - Oct 19, 2017 / Jul 6, 2018 - Nov 31, 2021 - * - ``<= 0.16.x`` - - Jan 11, 2014 / Apr 4, 2017 + * - ``0.16.x`` + - Nov 4, 2017 / Apr 4, 2017 + - Nov 31, 2021 + + * - ``0.15.x`` + - Jan 21 2016 / Feb 18, 2016 + - Nov 31, 2021 + + * - ``<= 0.14.x`` + - Jan 11, 2014 / Jun 9, 2015 - Unsupported Python ~~~~~~ -Python_ defines an EOL (End Of Life) date for all its versions. - -.. _Python: https://www.python.org/ +Python defines an EOL (End Of Life) date for all its versions. .. list-table:: :header-rows: 1 @@ -220,11 +223,11 @@ Python_ defines an EOL (End Of Life) date for all its versions. * - ``3.9.x`` (not available yet) - Oct 05, 2025 - - Dec 31, 2025 + - Jan 31, 2026 * - ``3.8.x`` - Oct 14, 2024 - - Dec 31, 2024 + - Jan 31, 2025 * - ``3.7.x`` - Jun 27, 2023 @@ -232,7 +235,7 @@ Python_ defines an EOL (End Of Life) date for all its versions. * - ``3.6.x`` - Dec 23, 2021 - - Jan 31, 2022 + - Mar 31, 2022 * - ``3.5.x`` - Sep 13, 2020 From 664cbb1bae7db51f2be1353bc4a96cc0f31b332f Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 25 Jan 2021 18:39:16 -0500 Subject: [PATCH 04/14] Match dates --- docs/supported-tools.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 0fd874ee0c0..185b456bcc0 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -66,7 +66,7 @@ Sphinx: New projects use the latest version. Mkdocs: - Projects created before April 3, 2019 use ``0.17.3``. + Projects created before April 3, 2019 (April 23 for :doc:`/commercial/index`) use ``0.17.3``. New projects use the latest version. sphinx-rtd-theme: From 0d94c4500914590a3aa91c2043c854c86b198cf6 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 25 Jan 2021 18:43:57 -0500 Subject: [PATCH 05/14] Match dates from .com --- docs/supported-tools.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 185b456bcc0..7a0b7bf1b15 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -66,11 +66,11 @@ Sphinx: New projects use the latest version. Mkdocs: - Projects created before April 3, 2019 (April 23 for :doc:`/commercial/index`) use ``0.17.3``. + 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 Oct 20, 2020 use ``0.4.3``. + Projects created before October 20, 2020 (January 21, 2021 for :doc:`/commercial/index`) use ``0.4.3``. New projects use the latest version. pip: From cb313e6d354b4d5b8ee733ed09832d396edbd2b4 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 26 Jan 2021 09:50:10 -0500 Subject: [PATCH 06/14] Apply suggestions from code review Co-authored-by: Manuel Kaufmann --- docs/supported-tools.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 7a0b7bf1b15..a8dcd8cccf3 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -7,15 +7,16 @@ In order to provide :doc:`several features `, Read the Docs needs to inject or modify some content while building your docs. When an incompatible change happens in one of these tools or dependencies, -we need to change our code as well to keep our features working, -this is done with backwards compatibility in mind. -But sometimes is hard to keep compatibility with old and new versions at the same time, -in order to continue moving forward on future development and features we need to drop support for some versions. +we need to change our code as well to keep our features working. +This is done with backwards compatibility in mind, +but sometimes is hard to keep compatibility with old and new versions at the same time. +In order to continue moving forward on future development and features, +we need to drop support for some versions. .. note:: Your existent documentation will always be kept online and working, - But **when support for a tool or dependency ends, new builds may fail**. + but **when support for a tool or dependency ends, new builds may fail**. .. contents:: Contents :local: @@ -26,8 +27,7 @@ End of support policy Our policy defines how long a given tool or dependency is considered supported. After it reaches its end of support date, -we don't offer support for builds/docs using these tools or dependencies, -you'll need to upgrade in order to receive support. +your builds may start failing and you will need to upgrade in order to receive support. For :doc:`/commercial/index` we provide an extended support of six months after the official end of support date. For tools that define an EOL date, we try to follow that date for our policy. From 88bf264c9aba4cbbca782023097f6109920d418f Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 26 Jan 2021 09:57:44 -0500 Subject: [PATCH 07/14] Updates --- docs/supported-tools.rst | 64 +++++++++++++++++++++++++--------------- 1 file changed, 40 insertions(+), 24 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index a8dcd8cccf3..2a17643d7ab 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -30,16 +30,19 @@ After it reaches its end of support date, your builds may start failing and you will need to upgrade in order to receive support. For :doc:`/commercial/index` we provide an extended support of six months after the official end of support date. -For tools that define an EOL date, we try to follow that date for our policy. -For tools that release their versions incrementally without an EOL date, -we choose a date based on: the release of mayor versions (versions with breaking changes), -the date since it was last updated, and its usage on our platform. +- For tools that define an :term:`EOL ` date, we try to follow that date for our policy. +- For tools that release their versions incrementally without an EOL date, + we choose a date based on: + + - The release versions with breaking changes (mayor versions). + - The date since it was last updated. + - And its usage on our platform. .. note:: Some recent versions may be supported, but aren't listed on these tables - (specially minor updates from supported versions), - contact us if you have doubts. + (specially minor updates from supported versions). + Contact us if you have doubts. Default dependencies -------------------- @@ -101,7 +104,7 @@ These are the dependencies that are installed by default when using a Conda envi Conda: Miniconda2 ``4.6.14`` - (could be updated to use the latest version by default). + (could be updated in the future to use the latest version by default). Mkdocs: Latest version by default installed via ``conda``. @@ -142,35 +145,43 @@ Sphinx releases its versions incrementally. :header-rows: 1 * - Version - - Released / Latest Update + - Released + - Latest Update - Supported Until * - ``3.x`` - - Apr 5, 2020 / ??? + - Apr 5, 2020 + - ??? - 5.0 is released or later/early * - ``2.x`` - - Mar 28, 2019 / Mar 5, 2020 + - Mar 28, 2019 + - Mar 5, 2020 - 4.0 is released or later/early * - ``1.8.x`` - - Sep 12, 2018 / Mar 10, 2019 + - Sep 12, 2018 + - Mar 10, 2019 - Nov 31, 2022 * - ``1.7.x`` - - Feb 12, 2018 / Sep 5, 2018 + - Feb 12, 2018 + - Sep 5, 2018 - Nov 31, 2022 * - ``1.6.x`` - - May 16, 2017 / Feb 4, 2017 + - May 16, 2017 + - Feb 4, 2017 - Nov 31, 2021 * - ``1.5.x`` - - Dec 5, 2016 / May 4, 2017 + - Dec 5, 2016 + - May 4, 2017 - Nov 31, 2021 * - ``<= 1.4.x`` - - Mar 21, 2008 / Nov 23, 2016 + - Mar 21, 2008 + - Nov 23, 2016 - Unsupported Mkdocs @@ -182,38 +193,43 @@ MkDocs releases its versions incrementally. :header-rows: 1 * - Version - - Released / Latest Update + - Released + - Latest Update - Supported Until * - ``1.1.x`` - - Feb 22, 2020 / ??? + - Feb 22, 2020 + - ??? - 3.0 released or later/early * - ``1.0.x`` - - Aug 3, 2018 / Sep 17, 2018 + - Aug 3, 2018 + - Sep 17, 2018 - 2.0 released or later/early * - ``0.17.x`` - - Oct 19, 2017 / Jul 6, 2018 + - Oct 19, 2017 + - Jul 6, 2018 - Nov 31, 2021 * - ``0.16.x`` - - Nov 4, 2017 / Apr 4, 2017 + - Nov 4, 2017 + - Apr 4, 2017 - Nov 31, 2021 * - ``0.15.x`` - - Jan 21 2016 / Feb 18, 2016 + - Jan 21 2016 + - Feb 18, 2016 - Nov 31, 2021 * - ``<= 0.14.x`` - - Jan 11, 2014 / Jun 9, 2015 + - Jan 11, 2014 + - Jun 9, 2015 - Unsupported Python ~~~~~~ -Python defines an EOL (End Of Life) date for all its versions. - .. list-table:: :header-rows: 1 From 8b1e92a6de074e9287c92630157e2bf51a485fd1 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 26 Jan 2021 10:01:39 -0500 Subject: [PATCH 08/14] Remove some sentences --- docs/supported-tools.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 2a17643d7ab..6b9c5a4b50a 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -139,8 +139,6 @@ Table of supported versions Sphinx ~~~~~~ -Sphinx releases its versions incrementally. - .. list-table:: :header-rows: 1 @@ -187,8 +185,6 @@ Sphinx releases its versions incrementally. Mkdocs ~~~~~~ -MkDocs releases its versions incrementally. - .. list-table:: :header-rows: 1 From 7b6a8481932e92c95971affa422816eb7f92cfdb Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 26 Jan 2021 10:15:25 -0500 Subject: [PATCH 09/14] More updates --- docs/supported-tools.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 6b9c5a4b50a..b2f05830aab 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -26,10 +26,12 @@ End of support policy --------------------- Our policy defines how long a given tool or dependency is considered supported. -After it reaches its end of support date, -your builds may start failing and you will need to upgrade in order to receive support. +Read the Docs will contact all users when an end of support date is close, +after that date your builds may start failing and you will need to upgrade in order to receive support. For :doc:`/commercial/index` we provide an extended support of six months after the official end of support date. +This is how we choose an end of support date: + - For tools that define an :term:`EOL ` date, we try to follow that date for our policy. - For tools that release their versions incrementally without an EOL date, we choose a date based on: From 23fe0023303e5aa2b9718910bb0ccb207efcb381 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 26 Jan 2021 11:21:32 -0500 Subject: [PATCH 10/14] Fix linter --- docs/supported-tools.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index b2f05830aab..0893acdd234 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -32,7 +32,7 @@ For :doc:`/commercial/index` we provide an extended support of six months after This is how we choose an end of support date: -- For tools that define an :term:`EOL ` date, we try to follow that date for our policy. +- For tools that define an :abbr:`EOL (End Of Life)` date, we try to follow that date for our policy. - For tools that release their versions incrementally without an EOL date, we choose a date based on: @@ -151,7 +151,7 @@ Sphinx * - ``3.x`` - Apr 5, 2020 - - ??? + - \??? - 5.0 is released or later/early * - ``2.x`` @@ -197,7 +197,7 @@ Mkdocs * - ``1.1.x`` - Feb 22, 2020 - - ??? + - \??? - 3.0 released or later/early * - ``1.0.x`` From d111c6ddaf1ce38449328f373ffc08b6146e9811 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Mon, 22 Mar 2021 11:52:52 -0500 Subject: [PATCH 11/14] Small updates --- docs/supported-tools.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 0893acdd234..789a1696672 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -58,8 +58,7 @@ For this reason we are now installing their latest version (or latest supported In order to keep your builds reproducible, it's highly recommended declaring its dependencies and versions explicitly. - - .. TODO: link to this guide once it's written https://github.com/readthedocs/readthedocs.org/issues/7852. + See :doc:`/guides/reproducible-builds`. External dependencies (Python) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -72,6 +71,7 @@ Sphinx: Mkdocs: Projects created before April 3, 2019 (April 23, 2019 for :doc:`/commercial/index`) use ``0.17.3``. + Projects created before March 9, 2021 use ``1.0.4``. New projects use the latest version. sphinx-rtd-theme: From 94feeb66b06ad6753036229272bed4a769e90907 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 6 Apr 2021 12:13:12 -0500 Subject: [PATCH 12/14] Small updates --- docs/supported-tools.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index 789a1696672..ad52b70d0f7 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -36,9 +36,9 @@ This is how we choose an end of support date: - For tools that release their versions incrementally without an EOL date, we choose a date based on: - - The release versions with breaking changes (mayor versions). + - A version with breaking changes is released (usually a mayor version update). - The date since it was last updated. - - And its usage on our platform. + - Its usage on our platform. .. note:: @@ -152,12 +152,12 @@ Sphinx * - ``3.x`` - Apr 5, 2020 - \??? - - 5.0 is released or later/early + - 5.0 released or later/early * - ``2.x`` - Mar 28, 2019 - Mar 5, 2020 - - 4.0 is released or later/early + - 4.0 released or later/early * - ``1.8.x`` - Sep 12, 2018 From a2bb332206495bccef02948573649f5459dd4beb Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 6 Apr 2021 17:09:06 -0500 Subject: [PATCH 13/14] Update docs/supported-tools.rst Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/supported-tools.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index ad52b70d0f7..ce8fb6e35ac 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -36,7 +36,7 @@ This is how we choose an end of support date: - For tools that release their versions incrementally without an EOL date, we choose a date based on: - - A version with breaking changes is released (usually a mayor version update). + - A version with breaking changes is released (usually a major version update). - The date since it was last updated. - Its usage on our platform. From bf2cc6da5c1db4a443540aee52548f43222266c5 Mon Sep 17 00:00:00 2001 From: Santos Gallegos Date: Tue, 6 Apr 2021 17:44:40 -0500 Subject: [PATCH 14/14] Link to the repo of rtd-ext --- docs/supported-tools.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/supported-tools.rst b/docs/supported-tools.rst index ce8fb6e35ac..34257e742e2 100644 --- a/docs/supported-tools.rst +++ b/docs/supported-tools.rst @@ -133,7 +133,7 @@ Internal dependencies are needed to integrate your docs with Read the Docs. We guarantee that these dependencies will work with all current supported versions of our tools, you don't need to specify them in your requirements. -- readthedocs-sphinx-ext +- `readthedocs-sphinx-ext `__ Table of supported versions ---------------------------