Repository navigation
Add the Read the Docs build configuration - #111
Merged
Merged
Conversation
The docs on Read the Docs have not been built since 2018, and builds now also need a .readthedocs.yaml, which this adds. The docs need only Sphinx, as conf.py mocks urwid, so nothing is installed beyond the default. Co-Authored-By: Claude Opus 5.5 <[email protected]>
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.
The docs on Read the Docs were last built on 2018-11-14; https://urwidtrees.readthedocs.io still serves 1.0.3.dev. Builds stopped because nothing triggered them (the repository has no Read the Docs webhook), and since 2023 Read the Docs also refuses to build without a
.readthedocs.yaml. This adds the minimal one: Ubuntu 24.04, Python 3.13 and the Sphinx configuration path. Read the Docs installs only Sphinx, which is all the docs need, asconf.pymocks urwid.Emulating the Read the Docs build (fresh venv with only Sphinx 9.2, no urwid, its exact
sphinx -T -b htmlcommand with-W) succeeds withmain'sconf.pyand with the one from #107.This file alone changes nothing on the site. In the Read the Docs dashboard for urwidtrees:
master(which no longer exists on GitHub) tomain;The
stableversion points at tag 1.0.2; once versions sync it will move to 1.0.5, which has no.readthedocs.yaml, so that build would fail until 1.1.0 is tagged. Deactivatingstable(or the old tags) in the dashboard avoids a red build.Review findings and resolution
review-correctness
master: not a file change; stated above as dashboard steps.stablewill fail once versions sync: stated above.conf.pyversions.review-design
fail_on_warning: truewas not in the commit message and, with Sphinx unpinned and no CI job building the docs, would turn the build red unnoticed on a future deprecation warning: removed.🤖 Generated with Claude Code