Documentation

#132220 has broken EPUB builds of documentation. This has been only partially fixed in #133720, because yet configuration of sphinxext-opengraph adds not closed tags to every page.

sphinx-doc/sphinxext-opengraph#136 and sphinx-doc/sphinxext-opengraph#137 have been opened upstream, but the PR is not merged.

Status update [2025-07-14]: now (after skipping OpenGraph custom tags in Docs conf.py) only 8 chapters fail to render in EPUB format. It can be addressed by any of sphinx-doc/sphinxext-opengraph#120 and sphinx-doc/sphinxext-opengraph#137, as far as I'm concerned. Adding a CI check definitely should help with the stability of EPUB build. Last year Inada made an effort to fix the EPUB (#118689).

Linked PRs

• gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds #136187
• gh-136155: Docs: check for EPUB fatal errors in CI #134074
• [3.14] gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds (GH-136187) #136382
• [3.13] gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds (GH-136187) #136383
• [3.12] gh-136155: Use sphinxext-opengraph v0.12.0 #136406
• GH-136155: Use sphinxext-opengraph v0.11.0 #137348
• [3.14] GH-136155: Use sphinxext-opengraph v0.11.0 (GH-137348) #137349
• [3.13] GH-136155: Use sphinxext-opengraph v0.11.0 (GH-137348) #137350
• GH-136155: Fail the EPUB check on fatal errors #137351
• GH-136155: Use sphinxext-opengraph v0.12.0 #137393
• [3.14] GH-136155: Use sphinxext-opengraph v0.12.0 (GH-137393) #137431
• [3.13] GH-136155: Use sphinxext-opengraph v0.12.0 (GH-137393) #137432
• [3.13] gh-136155: Docs: check for EPUB fatal errors in CI (GH-134074) #137538
• [3.14] gh-136155: Docs: check for EPUB fatal errors in CI (GH-134074) #137539
• [3.12] GH-136155: Use sphinxext-opengraph v0.12.0 (GH-137393) #138741
• [3.12] gh-136155: Docs: check for EPUB fatal errors in CI (GH-134074) #145471