← Back to issue list

Documentation on Read the Docs is outdated

View original Github issue

Metadata

Project
craft-cli
Number
#50
Type
issue
State
closed
Author
jugmac00
Labels
—
Created
Updated
Closed

Current evaluation

Read the Docs was serving stale docs because the RTD build recipe was broken. Fixed by merged PR #51 ("docs: update readthedocs recipe", commit fa4e139), which made builds succeed and deploy the new docs from #49.

Resolution: closed resolved

Reason: The stale RTD content and long-failed builds were addressed by PR #51, merged into main as commit fa4e139 updating the Read the Docs recipe; the maintainer (sergiusens) replied confirming and closed the issue once builds worked again.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Unfortunately, the new documentation (#49) has not landed on rtd yet, see https://craft-cli.readthedocs.io/en/latest/ ![Screenshot from 2022-01-18 21-28-28](https://user-images.githubusercontent.com/9895620/150013635-217616a5-1ddf-4f37-b5f0-7435e07c6a52.png) Interestingly, on https://readthedocs.org/projects/craft-cli/builds/ the last failed build is older than a month. P.S.: Documentation cannot be built locally as `tox` is broken, see #47

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Read the Docs was serving stale docs because the RTD build recipe was broken. Fixed by merged PR #51 ("docs: update readthedocs recipe", commit fa4e139), which made builds succeed and deploy the new docs from #49.
stealth/space-bunny-alpha — closed resolved Fixed stale Read the Docs content by merging PR #51 (fa4e139), which updated the documentation build recipe and deployed the new docs.
stealth/space-bunny-alpha — closed resolved Read the Docs was updated by merged PR #51, changing the RTD recipe so the documentation could build with the latest project configuration.
qwen/qwen3.6-35b-a3b — — Maintainer acknowledged the stale Read the Docs builds and closed the issue. RTD deployment was resolved, updating the documentation to reflect the latest changes.
qwen/qwen3.6-35b-a3b — — Read the Docs deployment stalled due to stale builds and a broken tox environment. The issue was closed after the maintainer updated the Read the Docs configuration to restore successful documentation builds.
qwen/qwen3.6-35b-a3b — — Closed. The Read the Docs build pipeline and tox configuration were fixed, resolving the outdated documentation deployment.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/craft-cli#51 (confidence 97%)

    Merged PR titled 'docs: update readthedocs recipe' (fa4e139) that repaired the RTD build so the new docs deploy; recorded as resolving #50.

  • Related To: canonical/craft-cli#49 (confidence 88%)

    Merged docs rewrite (d5f6567) whose content could not appear on RTD until the build recipe was fixed in #51.

  • Blocked By: canonical/craft-cli#47 (confidence 72%)

    Issue cites broken tox preventing local docs builds, which slowed local verification of the RTD fix.

Related issues

Issue Project State Summary Similarity
#51 docs: update readthedocs recipe craft-cli merged Merged PR #51 into main via fa4e139, updating the Read the Docs recipe and resolving outdated documentation in #50.
77%
#4258 docs: enable RTD builds snapcraft merged Merged PR #4258 enabled Read the Docs builds by adding documentation build configuration; merged as commit 4d0d75112.
72%
#219 docs: fix readthedocs documentation generation craft-parts merged Merged PR #219 (commit c70294ee, merge 996ed24e) fixed RTD doc builds: added missing packages to the readthedocs env, indexed the changelog, and removed outdated python-apt from setup.py. Shipped in release 1.7.0.
71%
#32 Link to documentation does not work craft-cli closed The Read the Docs link was restored by merged PR #51 (commit fa4e139), which updated the documentation build recipe; the reporter confirmed recovery.
71%