Skip to content

[3.13] gh-118689: Doc: fix ePub build (GH-118690) #118889

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

Merged
methane merged 1 commit into from
May 10, 2024
Merged

[3.13] gh-118689: Doc: fix ePub build (GH-118690) #118889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
gh-118689: Doc: fix ePub build (GH-118690) 
(cherry picked from commit 7ac933e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
  • Loading branch information
@methane @miss-islington
methane authored and miss-islington committed May 10, 2024
commit a51677403c64fddee695d985baa46af40cdf6218
4 changes: 4 additions & 0 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
# --------------------------------

Expand Down
1 change: 0 additions & 1 deletion Doc/library/allos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/tools/extensions/glossary_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {}
Expand Down
2 changes: 2 additions & 0 deletions Doc/tools/templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
</style>
{{ super() }}

{%- if not embedded %}
<meta name="readthedocs-addons-api-version" content="1">
<script type="text/javascript">
function onSwitch(event) {
Expand Down Expand Up @@ -127,4 +128,5 @@
}
});
</script>
{%- endif %}
{% endblock %}