Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bump Sphinx to 4.5.0 #17772

Merged
merged 3 commits into from
Jun 30, 2023
Merged

Bump Sphinx to 4.5.0 #17772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6fab43f
Bump Sphinx to 4.5.0
ana-borges Jun 28, 2023
f8594f4
Try with a more recent version of docutils and rtd
ana-borges Jun 29, 2023
0708662
Fix documented lower bound for sphinx_rtd_theme.
Zimmi48 Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ variables:
# $DATE is so we can tell what's what in the image list
# The $hash is the first 10 characters of the md5 of the Dockerfile. e.g.
# echo $(md5sum dev/ci/docker/bionic_coq/Dockerfile | head -c 10)
CACHEKEY: "bionic_coq-V2023-06-07-de28eea879"
CACHEKEY: "bionic_coq-V2023-06-29-2b9dca3152"
IMAGE: "$CI_REGISTRY_IMAGE:$CACHEKEY"

# By default, jobs run in the base switch; override to select another switch
Expand Down
2 changes: 1 addition & 1 deletion dev/ci/docker/bionic_coq/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ RUN apt-get update -qq && apt-get install --no-install-recommends -y -qq \
wdiff

# More dependencies of the sphinx doc, pytest for coqtail
RUN pip3 install docutils==0.16 sphinx==3.0.2 sphinx_rtd_theme==0.4.3 \
RUN pip3 install docutils==0.17.1 sphinx==4.5.0 sphinx_rtd_theme==1.0.0 \
antlr4-python3-runtime==4.7.1 sphinxcontrib-bibtex==0.4.2 \
pytest==5.4.3

Expand Down
4 changes: 2 additions & 2 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ To produce the complete documentation in HTML, you will need Coq dependencies
listed in [`INSTALL.md`](../INSTALL.md). Additionally, the Sphinx-based
reference manual requires Python 3, and the following Python packages:

- sphinx >= 3.0.2
- sphinx_rtd_theme >= 0.4.3
- sphinx >= 4.5.0
- sphinx_rtd_theme >= 1.0.0
- beautifulsoup4 >= 4.0.6
- antlr4-python3-runtime >= 4.7.1
- pexpect >= 4.2.1
Expand Down
7 changes: 7 additions & 0 deletions doc/changelog/12-infrastructure-and-dependencies/17772-bump-sphinx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- **Changed:**
Sphinx 4.5.0 or above is now required to build the reference manual, so now /
can be used as a quick search shortcut and Esc as a shortcut to remove search
highlighting
(`#17772 <https://github.com/coq/coq/pull/17772>`_,
fixes `#15778 <https://github.com/coq/coq/issues/15778>`_,
by Ana Borges).
2 changes: 1 addition & 1 deletion doc/sphinx/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '3.0.2'
needs_sphinx = '4.5.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down