Repository navigation
Update the Read the Docs build and the documentation theme - #264
Merged
Merged
Conversation
Build on Ubuntu 24.04 with Python 3.13, the version CI builds the docs with. Replace the 'default' theme, a legacy alias of Sphinx's 'classic' theme since Read the Docs no longer substitutes its own theme for it, by alabaster, the theme Sphinx uses by default. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PewzpjVeke4LTQ7Q88nyu6
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.
.readthedocs.yaml: build on Ubuntu 24.04 (was 22.04) with Python 3.13 (was 3.11), the version CI builds the docs with.doc/conf.py:html_theme = 'alabaster'instead of'default'.'default'is a legacy alias of Sphinx'sclassictheme. Read the Docs used to substitute its own theme for it, but no longer does, so the published docs fall back toclassic. Alabaster is the theme Sphinx itself uses by default and needs no extra dependency. If you prefer the Read the Docs look, the alternative issphinx_rtd_theme, which would have to be added todoc/requirements.txt.Verification
sphinx-build -W --keep-going -b htmlpasses locally with the new theme. The Read the Docs build itself could not be run from here; it will show up as a check on this PR if the project has PR builds enabled.Generated by Claude Code