🐛 fix(docs): fix ReadTheDocs build#29
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Feb 25, 2026
Merged
Conversation
gaborbernat
force-pushed
the
rewrite
branch
2 times, most recently
from
39ced82 to
e794535
Compare
The RTD build failed because the trailing `--` in the tox invocation set posargs to empty, causing sphinx-build to receive no output directory. Remove the `--`, let tox use the default output path, and copy the result to `$READTHEDOCS_OUTPUT/html` where RTD expects it. Also fix two RST title underlines that were too short, which caused failures under `-W` (warnings as errors). Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
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
1 participant
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.
The ReadTheDocs build was failing because the tox invocation ended with a bare
--, which set posargs to empty and causedsphinx-buildto receive no output directory argument. 🔧The fix passes
$READTHEDOCS_OUTPUT/htmlas posargs so sphinx-build writes directly to the path RTD expects. Two RST title underlines indocs/index.rstanddocs/explanation.rstwere also too short, tripping the-W(warnings as errors) flag.