From 5446f9716717fc5bf3e9093c9cf6f1c42b0ec55c Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 6 Jul 2023 12:31:56 +0200 Subject: [PATCH 1/2] MkDocs: fix `USE_MKDOCS_LATEST` feature flag logic The logic was inverted and we were installing old MkDocs version to projects with `USE_MKDOCS_LATEST` feature flag. Closes #10402 --- readthedocs/doc_builder/python_environments.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readthedocs/doc_builder/python_environments.py b/readthedocs/doc_builder/python_environments.py index 0b85408400f..e51cba703a4 100644 --- a/readthedocs/doc_builder/python_environments.py +++ b/readthedocs/doc_builder/python_environments.py @@ -211,8 +211,8 @@ def install_core_requirements(self): positive='mkdocs==0.17.3', negative=self.project.get_feature_value( Feature.USE_MKDOCS_LATEST, - positive='mkdocs<1.1', - negative='mkdocs', + positive="mkdocs", + negative="mkdocs<1.1", ), ), ) From 2e602eb5be8c23406d3186429ea43a1adf7076c1 Mon Sep 17 00:00:00 2001 From: Manuel Kaufmann Date: Thu, 6 Jul 2023 19:04:40 +0200 Subject: [PATCH 2/2] MkDocs: remove `USE_MKDOCS_LATEST` This is not required anymore since the logic was inverted and we were installing always the latest version for old projects, but the old version for new projects. It's better to have all of them installing the latest version and call it a day :) --- docs/user/build-default-versions.rst | 1 - readthedocs/doc_builder/python_environments.py | 8 ++------ readthedocs/projects/models.py | 2 -- 3 files changed, 2 insertions(+), 9 deletions(-) diff --git a/docs/user/build-default-versions.rst b/docs/user/build-default-versions.rst index 8a232b1f45c..9a242ad3688 100644 --- a/docs/user/build-default-versions.rst +++ b/docs/user/build-default-versions.rst @@ -41,7 +41,6 @@ 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: diff --git a/readthedocs/doc_builder/python_environments.py b/readthedocs/doc_builder/python_environments.py index e51cba703a4..211ee3102c7 100644 --- a/readthedocs/doc_builder/python_environments.py +++ b/readthedocs/doc_builder/python_environments.py @@ -209,12 +209,8 @@ def install_core_requirements(self): self.project.get_feature_value( Feature.DEFAULT_TO_MKDOCS_0_17_3, positive='mkdocs==0.17.3', - negative=self.project.get_feature_value( - Feature.USE_MKDOCS_LATEST, - positive="mkdocs", - negative="mkdocs<1.1", - ), - ), + negative="mkdocs", + ) ) else: requirements.extend( diff --git a/readthedocs/projects/models.py b/readthedocs/projects/models.py index 76dd2bfd4a0..7bf12f01c65 100644 --- a/readthedocs/projects/models.py +++ b/readthedocs/projects/models.py @@ -1927,7 +1927,6 @@ def add_features(sender, **kwargs): DONT_INSTALL_LATEST_PIP = 'dont_install_latest_pip' USE_SPHINX_LATEST = 'use_sphinx_latest' DEFAULT_TO_MKDOCS_0_17_3 = 'default_to_mkdocs_0_17_3' - USE_MKDOCS_LATEST = 'use_mkdocs_latest' USE_SPHINX_RTD_EXT_LATEST = 'rtd_sphinx_ext_latest' # Search related features @@ -2034,7 +2033,6 @@ def add_features(sender, **kwargs): DEFAULT_TO_MKDOCS_0_17_3, _("MkDOcs: Install mkdocs 0.17.3 by default"), ), - (USE_MKDOCS_LATEST, _("MkDocs: Use latest version of MkDocs")), ( USE_SPHINX_RTD_EXT_LATEST, _("Sphinx: Use latest version of the Read the Docs Sphinx extension"),