Repository navigation
docs: report reStructuredText errors and fix duplicated image substitutions - #537
Merged
Merged
Conversation
…utions doc/conf.py suppressed every docutils message so that the duplicate substitution definitions of doc/index.rst and doc/intro/index.rst, defined once for HTML and once for LaTeX in `only::` blocks, would not fail the strict gettext build. Any reStructuredText error went unnoticed as a result. Moreover, these duplicates were not harmless: docutils keeps the last definition for every builder, before `only::` filtering, so the HTML pages used the LaTeX definitions: the funders' logos and the operating mode icons were 1cm wide instead of 64px, had a white background in the dark theme, and the logos opened the image instead of the funders' websites. - Define each image once, with its HTML attributes and a `latex-icon` class, which a `doctree-resolved` hook of doc/conf.py sizes to 1cm in the LaTeX output - Stop suppressing docutils messages - Release note entry and French translation Closes #521 Assisted-by: Claude Opus 5.5
This was referenced Nov 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #521
Summary
doc/conf.pysuppressed every docutils message (suppress_warnings = ["docutils"]), so reStructuredText errors went unnoticed, even in the strict gettext build (-W). The suppression was added for the duplicate substitution definitions ofdoc/index.rstanddoc/intro/index.rst, defined once for HTML (64px) and once for LaTeX (1cm) inonly::blocks. These duplicates were actually not harmless: docutils keeps the last definition for every builder, before theonly::filtering, so the HTML pages used the LaTeX definitions. On the published site, the funders' logos and the operating mode icons are 1cm wide instead of 64px, get a white background in the dark theme, and the logos open the image instead of the CEA, CODRA and NLnet websites.Without the suppression, these 6 duplicates were the only docutils errors left (title errors were fixed by #524).
Changes
latex-iconclass; adoctree-resolvedhook ofdoc/conf.py,size_latex_icons, sizes the images of this class to 1cm in the LaTeX output (the PDF is unchanged, except that the logos are now links)Validation
python -m sphinx build doc build/gettext -b gettext -W -E(the CI command) fails with the suppression removed and the duplicates kept (6 "Duplicate substitution definition name" errors), and succeeds with the fixdark-lightclass, logos linking to their websites; LaTeX:\sphinxincludegraphics[width=1cm]for the same imagesdoc/conf.pyOut of scope
pages.yml, release builds or local buildsRelease note: entry in the 📖 Documentation section of DataLab 1.4.1. This PR targets
release(1.4.1 maintenance line); the commit will be cherry-picked intodevelop.Assisted-by: Claude Opus 5.5