Skip to content

Commit 9c451a2

Browse files
Update sphinx version (#6415)
* Use the current Sphinx version 7.x * Change language to `en` for Sphinx * Update sphinx config name `master_doc` -> `root_doc` Ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-master_doc * Remove package pinning workarounds introduced for #6400. Also remove an old pinning of the Jinja2 package which is unlikely to be still necessary. Fixes #6400 --------- Co-authored-by: Pavol Juhas <[email protected]>
1 parent 8ae5bbb commit 9c451a2

File tree

2 files changed

+4
-15
lines changed

2 files changed

+4
-15
lines changed

rtd_docs/conf.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
# -- Project information -----------------------------------------------------
2525

2626
project = 'Cirq'
27-
copyright = '2018-2020, The Cirq Developers' # pylint: disable=redefined-builtin
27+
copyright = '2018-2024, The Cirq Developers' # pylint: disable=redefined-builtin
2828
author = 'The Cirq Developers'
2929

3030
# The short X.Y version
@@ -51,14 +51,14 @@
5151
source_suffix = {'.rst': 'restructuredtext', '.md': 'markdown'}
5252

5353
# The main toctree document.
54-
master_doc = 'index'
54+
root_doc = 'index'
5555

5656
# The language for content autogenerated by Sphinx. Refer to documentation
5757
# for a list of supported languages.
5858
#
5959
# This is also used if you do content translation via gettext catalogs.
6060
# Usually you set "language" from the command line for these cases.
61-
language = None
61+
language = 'en'
6262

6363
# List of patterns, relative to source directory, that match files and
6464
# directories to ignore when looking for source files.

rtd_docs/requirements.txt

+1-12
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
# For generating documentation.
2-
3-
# TODO(#6400,juhas) - upgrade Sphinx and remove the package pins below -------
4-
alabaster<=0.7.13
5-
sphinxcontrib-applehelp<=1.0.7
6-
sphinxcontrib-devhelp<=1.0.5
7-
sphinxcontrib-htmlhelp<=2.0.4
8-
sphinxcontrib-qthelp<=1.0.6
9-
sphinxcontrib-serializinghtml<=1.1.9
10-
# End of TODO ----------------------------------------------------------------
11-
122
myst-parser
13-
Sphinx~=3.2.0
3+
Sphinx==7.*
144
sphinx_rtd_theme
155
sphinx-notfound-page
16-
Jinja2<=3.0.3

0 commit comments

Comments
 (0)