gh-118689: Doc: fix ePub build (#118690)

python · May 10, 2024 · 7ac933e · 7ac933e
1 parent 7cc5e81
commit 7ac933e
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/Doc/conf.py b/Doc/conf.py
@@ -435,6 +435,10 @@
 epub_author = 'Python Documentation Authors'
 epub_publisher = 'Python Software Foundation'
 
+# index pages are not valid xhtml
+# https://github.com/sphinx-doc/sphinx/issues/12359
+epub_use_index = False
+
 # Options for the coverage checker
 # --------------------------------
 

diff --git a/Doc/library/allos.rst b/Doc/library/allos.rst
@@ -16,7 +16,6 @@ but they are available on most other systems as well.  Here's an overview:
    io.rst
    time.rst
    argparse.rst
-   getopt.rst
    logging.rst
    logging.config.rst
    logging.handlers.rst

diff --git a/Doc/tools/extensions/glossary_search.py b/Doc/tools/extensions/glossary_search.py
@@ -20,7 +20,7 @@
 
 
 def process_glossary_nodes(app, doctree, fromdocname):
-    if app.builder.format != 'html':
+    if app.builder.format != 'html' or app.builder.embedded:
         return
 
     terms = {}

diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html
@@ -42,6 +42,7 @@
     </style>
 {{ super() }}
 
+{%- if not embedded %}
 <meta name="readthedocs-addons-api-version" content="1">
 <script type="text/javascript">
  function onSwitch(event) {
@@ -127,4 +128,5 @@
    }
  });
 </script>
+{%- endif %}
 {% endblock %}