From 0b880469930283913bb26cf6ed529e973efc25d4 Mon Sep 17 00:00:00 2001 From: Sam Burdick Date: Tue, 16 Jan 2024 12:25:39 -0800 Subject: [PATCH 1/4] Update sphinx version --- rtd_docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rtd_docs/requirements.txt b/rtd_docs/requirements.txt index c6e5451371a..bf8b3984a3b 100644 --- a/rtd_docs/requirements.txt +++ b/rtd_docs/requirements.txt @@ -2,7 +2,7 @@ # TODO(#6400,juhas) - upgrade Sphinx and remove the alabaster pin below alabaster<=0.7.13 myst-parser -Sphinx~=3.2.0 +Sphinx~=7.2.6 sphinx_rtd_theme sphinx-notfound-page Jinja2<=3.0.3 From d7697cff9af7d5841244f13a61ee5ad4b2593e94 Mon Sep 17 00:00:00 2001 From: Sam Burdick Date: Tue, 16 Jan 2024 12:33:31 -0800 Subject: [PATCH 2/4] Change language to en for Sphinx --- rtd_docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rtd_docs/conf.py b/rtd_docs/conf.py index d2a1f071694..2a1d00c80e9 100644 --- a/rtd_docs/conf.py +++ b/rtd_docs/conf.py @@ -58,7 +58,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From ab0bf99e0a7061a61d3499db3f38dbc53d3af5bb Mon Sep 17 00:00:00 2001 From: Pavol Juhas Date: Tue, 16 Jan 2024 16:04:50 -0800 Subject: [PATCH 3/4] Update sphinx config name `master_doc` -> `root_doc` And bump up the copyright year as well. Ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-master_doc --- rtd_docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rtd_docs/conf.py b/rtd_docs/conf.py index 2a1d00c80e9..b09e694ac8d 100644 --- a/rtd_docs/conf.py +++ b/rtd_docs/conf.py @@ -24,7 +24,7 @@ # -- Project information ----------------------------------------------------- project = 'Cirq' -copyright = '2018-2020, The Cirq Developers' # pylint: disable=redefined-builtin +copyright = '2018-2024, The Cirq Developers' # pylint: disable=redefined-builtin author = 'The Cirq Developers' # The short X.Y version @@ -51,7 +51,7 @@ source_suffix = {'.rst': 'restructuredtext', '.md': 'markdown'} # The main toctree document. -master_doc = 'index' +root_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. From 152d47ed47713509b07f7c9014a18a3e81ed198a Mon Sep 17 00:00:00 2001 From: Pavol Juhas Date: Tue, 16 Jan 2024 16:08:00 -0800 Subject: [PATCH 4/4] Require Sphinx-7.* instead of Sphinx-7.2.* Remove package pinning workarounds introduced for #6400. Also remove an old pinning of the Jinja2 package which is unlikely to be still needed. --- rtd_docs/requirements.txt | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/rtd_docs/requirements.txt b/rtd_docs/requirements.txt index 59ae75bafa2..37e0fef66f3 100644 --- a/rtd_docs/requirements.txt +++ b/rtd_docs/requirements.txt @@ -1,16 +1,5 @@ # For generating documentation. - -# TODO(#6400,juhas) - upgrade Sphinx and remove the package pins below ------- -alabaster<=0.7.13 -sphinxcontrib-applehelp<=1.0.7 -sphinxcontrib-devhelp<=1.0.5 -sphinxcontrib-htmlhelp<=2.0.4 -sphinxcontrib-qthelp<=1.0.6 -sphinxcontrib-serializinghtml<=1.1.9 -# End of TODO ---------------------------------------------------------------- - myst-parser -Sphinx~=7.2.6 +Sphinx==7.* sphinx_rtd_theme sphinx-notfound-page -Jinja2<=3.0.3