Merge branch '5.0.x' into 5.x

sphinx-doc · Jun 30, 2022 · b9736f2 · b9736f2
2 parents c327f09 + a7ef63a
commit b9736f2
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 5 deletions.
diff --git a/CHANGES b/CHANGES
@@ -61,6 +61,12 @@ Features added
 Bugs fixed
 ----------
 
+* #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
+* #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due
+  to missing ``Node.findall()``
+* #10506: LaTeX: build error when using ``:cpp:stuff`` syntax highlighting in
+  figure caption
+
 Testing
 --------
 

diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py
@@ -245,7 +245,7 @@ def write_stylesheet(self) -> None:
         with open(stylesheet, 'w', encoding="utf-8") as f:
             f.write('\\NeedsTeXFormat{LaTeX2e}[1995/12/01]\n')
             f.write('\\ProvidesPackage{sphinxhighlight}'
-                    '[2016/05/29 stylesheet for highlighting with pygments]\n')
+                    '[2022/06/30 stylesheet for highlighting with pygments]\n')
             f.write('% Its contents depend on pygments_style configuration variable.\n\n')
             f.write(highlighter.get_stylesheet())
 

diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py
@@ -40,9 +40,14 @@
                    ord('}'): '\\PYGZcb{}'}
 
 # used if Pygments is available
-# use textcomp quote to get a true single quote
 _LATEX_ADD_STYLES = r'''
+% Sphinx additions
+% use textcomp quote to get a true single quote
 \renewcommand\PYGZsq{\textquotesingle}
+\makeatletter
+% use \protected to allow \PYG in \caption
+\protected\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+{\PYG@do{#2}}}
+\makeatother
 '''
 # fix extra space between lines when Pygments highlighting uses \fcolorbox
 # add a {..} to limit \fboxsep scope, and force \fcolorbox use correct value
@@ -52,7 +57,7 @@
 % fix for Pygments <= 2.7.4
 \let\spx@original@fcolorbox\fcolorbox
 \def\spx@fixpyg@fcolorbox{\fboxsep-\fboxrule\spx@original@fcolorbox}
-\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+%
+\protected\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+%
              {\let\fcolorbox\spx@fixpyg@fcolorbox\PYG@do{#2}}}
 \makeatother
 '''

diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t
@@ -686,9 +686,11 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
+{%- if docutils_version_info[:2] < (0, 18) %}
 dl.field-list > dt:after {
     content: ":";
 }
+{% endif %}
 
 dl.field-list > dd {
     padding-left: 0.5em;

diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py
@@ -550,9 +550,9 @@ def unknown_visit(self, node: Node) -> None:
 
 
 # Node.findall() is a new interface to traverse a doctree since docutils-0.18.
-# This applies a patch docutils-0.17 or older to be available Node.findall()
+# This applies a patch to docutils up to 0.18 inclusive to provide Node.findall()
 # method to use it from our codebase.
-if docutils.__version_info__ < (0, 18):
+if docutils.__version_info__ <= (0, 18):
     def findall(self, *args, **kwargs):
         return iter(self.traverse(*args, **kwargs))