Update website theme for newer Sphinx #15365

requirements-dev.txt

@@ -17,19 +17,19 @@ lxml==4.9.2
 
 # This version is mentioned in `site/source/docs/site/about.rst`.
 # Please keep them in sync.
-sphinx==8.1.3
+sphinx==7.1.2
 # See https://github.com/emscripten-core/emscripten/issues/21590
 sphinxcontrib-applehelp==1.0.7
 sphinxcontrib-devhelp==1.0.6
-sphinxcontrib-htmlhelp==2.0.6
-sphinxcontrib-serializinghtml==1.1.9
+sphinxcontrib-htmlhelp>=2.0.0
+sphinxcontrib-serializinghtml>=1.1.5
 sphinxcontrib-qthelp==1.0.6
 sphinxcontrib-jquery==4.0
-alabaster==0.7.14
-pygments==2.17.2
-jinja2==3.1
+alabaster<0.8,>=0.7
+pygments>=2.13
+jinja2>=3.0
 
-docutils==0.22
+docutils<0.21,>=0.18.1
 
 # Needed by test/test_sockets.py
 websockify==0.10.0

site/Makefile

@@ -4,13 +4,13 @@
 # You can set these variables from the command line.
 SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
-SPHINXVERSION = 8.1.3
+SPHINXVERSION = 7.1.2
 PAPER         =
 BUILDDIR      = build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx version 8.1.3 installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx version 7.1.2 installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
 endif
 
 ifneq ($(shell $(SPHINXBUILD) --version), $(SPHINXBUILD) $(SPHINXVERSION))

site/source/_themes/emscripten_sphinx_rtd_theme/layout.html

@@ -169,7 +169,7 @@
         {%- block mobile_nav %}
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <!-- <a href="{{ pathto(master_doc) }}">{{ project }}</a> -->
-          <a href="{{ pathto(master_doc) }}"> <img src="{{ url_root }}/_static/{{ logo }}" alt="Logo" /> </a>
+          <a href="{{ pathto(master_doc) }}"> <img src="{{ logo_url }}" alt="Logo" /> </a>
         {%- endblock %}
       </nav>
 

site/source/_themes/emscripten_sphinx_rtd_theme/search.html

@@ -5,31 +5,37 @@
   Template for the search page.
 
   :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
-  :license: BSD, see LICENSE for details.
+  :license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
 #}
 {%- extends "layout.html" %}
 {% set title = _('Search') %}
-{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% set display_vcs_links = False %}
+{%- block scripts %}
+  {{ super() }}
+  <script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
+  <script src="{{ pathto('_static/language_data.js', 1) }}"></script>
+{%- endblock %}
 {% block footer %}
-<script type="text/javascript">
+<script>
   jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
 </script>
 {# this is used when loading the search index using $.ajax fails,
    such as on Chrome for documents on localhost #}
-<script type="text/javascript" id="searchindexloader"></script>
+<script id="searchindexloader"></script>
 {{ super() }}
 {% endblock %}
 {% block body %}
 <noscript>
 <div id="fallback" class="admonition warning">
   <p class="last">
-    {% trans %}Please activate JavaScript to enable the search
+    {% trans trimmed %}Please activate JavaScript to enable the search
     functionality.{% endtrans %}
   </p>
 </div>
 </noscript>
 
 {% if search_performed %}
+  {# Translators: Search is a noun, not a verb #}
   <h2>{{ _('Search Results') }}</h2>
   {% if not search_results %}
     <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>

site/source/conf.py

@@ -56,6 +56,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
+sys.path.insert(0, os.path.abspath('_themes'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
@@ -65,6 +66,7 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinxcontrib.jquery',
+    'emscripten_sphinx_rtd_theme',
     # 'breathe', #added by HamishW
 ]
 

site/source/docs/site/about.rst

@@ -4,7 +4,7 @@
 About this site
 ===============
 
-The site is built using `Sphinx <https://www.sphinx-doc.org/en/master/>`_ (8.1.3), the open source tool used to create the official Python documentation and many other sites. This is a very mature and stable tool, and was selected for, among other reasons, its support for defining API items and linking to them from code.
+The site is built using `Sphinx <https://www.sphinx-doc.org/en/master/>`_ (7.1.2), the open source tool used to create the official Python documentation and many other sites. This is a very mature and stable tool, and was selected for, among other reasons, its support for defining API items and linking to them from code.
 
 The site uses a custom theme, which is based on the :ref:`read-the-docs-theme`.
 

site/source/index.rst

@@ -31,3 +31,4 @@
   docs/optimizing/Profiling-Toolchain
 
   docs/site/about
+  genindex