From fcf107279dcc0c7b208c68d5b2fd9deb3d0d11cd Mon Sep 17 00:00:00 2001 From: j-n-c Date: Tue, 18 Oct 2022 16:32:44 +0100 Subject: [PATCH 1/2] #9074 - Added support for building sphynx docs using python 3.10+ --- doc/sphinx-guides/requirements.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/sphinx-guides/requirements.txt b/doc/sphinx-guides/requirements.txt index 4488c54cd5e..eb9f952d013 100755 --- a/doc/sphinx-guides/requirements.txt +++ b/doc/sphinx-guides/requirements.txt @@ -1,5 +1,7 @@ -# current version as of this writing -Sphinx==3.5.4 +# Necessary workaround for building Sphynx guides with Python 3.10+ versions +Sphinx==3.5.4 ; python_version < '3.10' +Sphinx==5.3.0 ; python_version >= '3.10' + # Necessary workaround for ReadTheDocs for Sphinx 3.x - unnecessary as of Sphinx 4.5+ Jinja2>=3.0.2,<3.1 From 1ab8f03b246c6f24f3871c2c50e71e6dbc8a2f16 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 16 Dec 2022 16:22:09 -0500 Subject: [PATCH 2/2] ask devs to use same sphinx version as prod #9074 --- doc/sphinx-guides/requirements.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/sphinx-guides/requirements.txt b/doc/sphinx-guides/requirements.txt index eb9f952d013..028f07d11cb 100755 --- a/doc/sphinx-guides/requirements.txt +++ b/doc/sphinx-guides/requirements.txt @@ -1,4 +1,7 @@ -# Necessary workaround for building Sphynx guides with Python 3.10+ versions +# Developers, please use Python 3.9 or lower to build the guides. +# For your convenience, a solution for Python 3.10 is provided below +# but we would prefer that you use the same version of Sphinx +# (below on the < 3.10 line) that is used to build the production guides. Sphinx==3.5.4 ; python_version < '3.10' Sphinx==5.3.0 ; python_version >= '3.10'