Merge pull request #1131 from gusthoff/topic/infrastructure/sphinx/updates/20241026

Python: upgrading to Sphinx 8.x

Author: gusthoff

.github/workflows/sphinx-books-tests.js.yml

@@ -45,6 +45,7 @@ jobs:
         texlive-fonts-extra \
         latexmk \
         texlive-xetex \
+        xindy \
         fonts-lmodern \
         fonts-open-sans \
         fonts-dejavu \

Vagrantfile

@@ -113,6 +113,7 @@ $epub = <<-SHELL
       texlive-fonts-extra \
       latexmk \
       texlive-xetex \
+      xindy \
       fonts-lmodern \
       fonts-open-sans \
       fonts-dejavu \

frontend/requirements.txt

@@ -1,14 +1,14 @@
-coverage==7.6.0
-docutils==0.20.1
+coverage==7.6.4
+docutils==0.21.2
 graphviz==0.20.3
-ipython==8.26.0
+ipython==8.29.0
 pdf2image==1.17.0
-pillow==10.4.0
+pillow==11.0.0
 pydot-ng==2.0.0
 Pygments==2.18.0
-pyparsing==3.1.2
-Sphinx==7.4.7
+pyparsing==3.2.0
+Sphinx==8.1.3
 sphinx-reredirects==0.1.5
-sphinx-rtd-theme==2.0.0
+sphinx-rtd-theme==3.0.1
 sphinxcontrib-plantuml==0.30
 websocket-client==1.8.0

frontend/requirements_frozen.txt

@@ -1,48 +1,48 @@
-alabaster==0.7.16
+alabaster==1.0.0
 asttokens==2.4.1
-Babel==2.15.0
-certifi==2024.7.4
-charset-normalizer==3.3.2
-coverage==7.6.0
+babel==2.16.0
+certifi==2024.8.30
+charset-normalizer==3.4.0
+coverage==7.6.4
 decorator==5.1.1
-docutils==0.20.1
-executing==2.0.1
+docutils==0.21.2
+executing==2.1.0
 graphviz==0.20.3
-idna==3.7
+idna==3.10
 imagesize==1.4.1
-ipython==8.26.0
+ipython==8.29.0
 jedi==0.19.1
 Jinja2==3.1.4
-MarkupSafe==2.1.5
+MarkupSafe==3.0.2
 matplotlib-inline==0.1.7
 packaging==24.1
 parso==0.8.4
 pdf2image==1.17.0
 pexpect==4.9.0
-pillow==10.4.0
-prompt_toolkit==3.0.47
+pillow==11.0.0
+prompt_toolkit==3.0.48
 ptyprocess==0.7.0
 pure-eval==0.2.3
 pydot-ng==2.0.0
 Pygments==2.18.0
-pyparsing==3.1.2
+pyparsing==3.2.0
 requests==2.32.3
 six==1.16.0
 snowballstemmer==2.2.0
-Sphinx==7.4.7
+Sphinx==8.1.3
 sphinx-reredirects==0.1.5
-sphinx-rtd-theme==2.0.0
-sphinxcontrib-applehelp==1.0.8
-sphinxcontrib-devhelp==1.0.6
-sphinxcontrib-htmlhelp==2.0.6
+sphinx-rtd-theme==3.0.1
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
 sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-plantuml==0.30
-sphinxcontrib-qthelp==1.0.8
-sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
 stack-data==0.6.3
 traitlets==5.14.3
 typing_extensions==4.12.2
-urllib3==2.2.2
+urllib3==2.2.3
 wcwidth==0.2.13
 websocket-client==1.8.0

frontend/sphinx/conf.py

@@ -221,8 +221,6 @@ def get_file_from_conf_ini(path_to_file):
                           '[GNATcheck Reference Manual: %s]'),
     'gnat_stack_ug_url': ('http://docs.adacore.com/live/wave/gnatstack/html/gnatstack_ug/%s',
                           '[GNATstack User\'s Guide: %s]'),
-    'cwe': ('https://cwe.mitre.org/data/definitions/%s.html',
-                          '[CWE-%s]'),
     }
 
 extlinks_detect_hardcoded_links = True
@@ -252,9 +250,8 @@ def get_file_from_conf_ini(path_to_file):
 #
 html_theme_options = {
     'logo_only': True,
-#    'analytics_id': '',
-#    'analytics_anonymize_ip': False,
-    'display_version': False,
+    'flyout_display': 'hidden',
+    'version_selector': False,
     'prev_next_buttons_location': 'bottom',
     'style_external_links': False,
     'vcs_pageview_mode': '',
@@ -487,8 +484,10 @@ def get_file_from_conf_ini(path_to_file):
 
 def setup(app):
 
+    outdir = str(app.outdir)
+
     # TODO: find a better way to retrieve the current target (html/latex/epub)
-    if 'html' in app.outdir:
+    if 'html' in outdir:
         templates_path.append('_templates')
 
         redirects.update({
@@ -517,10 +516,10 @@ def setup(app):
 
                 if not os.getenv('SPHINX_LOCAL_BUILD'):
                     raise e
-    elif 'epub' in app.outdir:
+    elif 'epub' in outdir:
         if config.has_option('', 'cover_page'):
             pdf_cover_page = get_file_from_conf_ini(config['DEFAULT']['cover_page'])
-            png_cover_page = app.outdir + "/" + '_static/cover.jpeg'
+            png_cover_page = outdir + "/" + '_static/cover.jpeg'
 
             pages = convert_from_path(pdf_path=pdf_cover_page,
                                       dpi=72,

frontend/sphinx/widget_extension.py

@@ -260,8 +260,7 @@ def run(self) -> List[Node]:
             widget.parseContent(self.content)
 
             # Attemping to detect HTML or Latex output by checking for 'html' in tags
-            if ('builder_html' in self.state.state_machine.document.settings.env.app.tags.tags
-                and self.state.state_machine.document.settings.env.app.tags.tags['builder_html']):
+            if (self.state.state_machine.document.settings.env.app.tags.eval_condition('builder_html')):
 
                 jinja_env = Environment(
                     loader=PackageLoader('widget'),

frontend/vm_apt_epub.txt

@@ -34,6 +34,7 @@ byobu=5.133-1.1ubuntu1
 bzip2=1.0.8-5build1
 ca-certificates=20230311ubuntu1
 ca-certificates-java=20230710
+clisp=1:2.49.20210628.gitde01f0f-3.1
 cloud-guest-utils=0.33-1
 cloud-init=24.1.3-0ubuntu1~23.10.6
 cloud-initramfs-copymods=0.47ubuntu1
@@ -353,6 +354,7 @@ libext2fs2:amd64=1.47.0-2ubuntu1
 libfakeroot:amd64=1.32.1-1
 libfastjson4:amd64=1.2304.0-1
 libfdisk1:amd64=2.39.1-4ubuntu2.2
+libffcall1b:amd64=2.4-2
 libffi8:amd64=3.4.4-1
 libfido2-1:amd64=1.13.0-1
 libfile-basedir-perl=0.09-2
@@ -1020,6 +1022,8 @@ xdg-utils=1.1.3-4.1ubuntu3
 xfonts-encodings=1:1.0.5-0ubuntu2
 xfonts-utils=1:7.7+6build2
 xfsprogs=6.3.0-1ubuntu1
+xindy=2.5.1.20160104-11build1
+xindy-rules=2.5.1.20160104-11build1
 xkb-data=2.38-2
 xml-core=0.18+nmu1
 xorg-sgml-doctools=1:1.11-1.1