Skip to content

Add the Read the Docs build configuration - #111

Merged
pazz merged 1 commit into
mainfrom
readthedocs-config
Oct 25, 2026
Merged

pazz merged 1 commit into
mainfrom
readthedocs-config

Conversation

@pazz

@pazz pazz commented Oct 25, 2026

Copy link
Copy Markdown
Owner

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, as conf.py mocks urwid.

Emulating the Read the Docs build (fresh venv with only Sphinx 9.2, no urwid, its exact sphinx -T -b html command with -W) succeeds with main's conf.py and with the one from #107.

This file alone changes nothing on the site. In the Read the Docs dashboard for urwidtrees:

  • Settings: change the default branch from master (which no longer exists on GitHub) to main;
  • Integrations: connect GitHub or add the webhook, so pushes trigger builds;
  • start a build by hand once to check.

The stable version 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. Deactivating stable (or the old tags) in the dashboard avoids a red build.

Review findings and resolution

review-correctness

  • The commit message claimed the missing file was why builds stopped; builds stopped in 2018 for lack of a trigger: fixed, the message now says both.
  • The file alone does not restore builds, as the Read the Docs default branch is master: not a file change; stated above as dashboard steps.
  • stable will fail once versions sync: stated above.
  • Checked without findings: the schema against the v2 reference, the install step, the emulated build with both conf.py versions.

review-design

  • fail_on_warning: true was 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.
  • The header comment repeated the filename: removed.
  • Pinning Sphinx: left; the docs build cleanly on the latest, and a pin adds a file to maintain.

🤖 Generated with Claude Code

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]>
@pazz
pazz merged commit 622e6c5 into main Oct 25, 2026
4 checks passed
@pazz
pazz deleted the readthedocs-config branch October 25, 2026 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant