docs(readme): add readthedocs build badge
Metadata
Current evaluation
PR #392 by mr-cal was merged (commit b0b9750), adding a readthedocs.org build-status badge to README.md. Author also noted the docs build was failing.
Resolution: closed resolved
Reason: The PR was approved (3 reviewers, no unresolved comments) and merged to main as commit b0b9750 "docs(readme): add readthedocs build badge (#392)". README.md now shows the 'Documentation Status' (rtd-badge) link reference alongside the Codecov and Ruff badges.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
-----
A badge to indicate if the docs are building.
Preview here: https://github.com/canonical/craft-providers/tree/docs-update#readme
And yes, the docs are indeed failing to build.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | PR #392 by mr-cal was merged (commit b0b9750), adding a readthedocs.org build-status badge to README.md. Author also noted the docs build was failing. | |
| qwen/qwen3.6-35b-a3b | — | closed resolved | Merged into main, adding a ReadTheDocs build badge to the README to monitor documentation build status. |
Update history
| Date | Change |
|---|---|
| created |
Related work
-
Related To:
craft-providers#224
(confidence 60%)
Earlier commit 7dcd9c9 'readme: update readthedocs link (#224)' touched the same readthedocs link reference definitions.
-
Related To:
craft-providers#470
(confidence 45%)
Commit a5fc284 'docs(readme): add weekly test and code coverage badges (#470)' later added further badges to the same badge block.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #4350 docs(readme): add readthedocs build badge | snapcraft | merged | Merged PR #4350, adding a Read the Docs build-status badge to the README and splitting badges onto separate lines (commit dda73543f). | |
| #555 docs(readme): add readthedocs build badge | craft-parts | merged | Merged PR #555 in commit 0db20448, adding a Read the Docs build-status badge to the README. | |
| #203 docs(readme): add badges | starbase | merged | Merged PR #203 (commit 76f2dbd) added tests/docs/coverage badges to starbase's README, fixing #180 after sphinx-lint line-length failures were resolved by merged PR #221 (1d72f49). | |
| #193 docs: rework badges | imagecraft | merged | PR #193 merged as commit dea806e ("docs: rework badges"): dropped broken README badges and added Codecov coverage, Ruff and Snap Store badges, +16/-8 lines in README.md. | |
| #470 docs(readme): add weekly test and code coverage badges | craft-providers | merged | Merged PR #470 added weekly test and code coverage badges to the README in commit a5fc284. | |
| #469 docs(readme): add status badge for weekly tests | craft-providers | closed | Closed unmerged as the README update was superseded by PR #470, which added weekly-test and coverage badges and merged as commit a5fc284. |