← Back to issue list

docs: enable RTD builds

View original Github issue

Metadata

Project
snapcraft
Number
#4258
Type
pull request
State
merged
Author
dboddie
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #4258 enabled Read the Docs builds by adding documentation build configuration; merged as commit 4d0d75112.

Resolution: closed resolved

Reason: The RTD configuration change was approved and merged into main as commit 4d0d75112, with GitHub recording PR #4258 as merged.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [x] Have you successfully run `pytest tests/unit`? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #4258 enabled Read the Docs builds by adding documentation build configuration; merged as commit 4d0d75112.
stealth/space-bunny-alpha — closed resolved Merged in snapcore/snapcraft#4258 as commit 4d0d75112, adding documentation configuration to enable Read the Docs builds.
qwen/qwen3.6-35b-a3b — — Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file.
qwen3.6-35b-a3b-mtp-q6 — — Merged into main to enable ReadTheDocs builds. Changes passed lint and unit tests. Codecov noted a minor 0.03% coverage decrease upon integration.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#5468 docs: fix RTD build snapcraft merged Merged PR #5468 as 0157e5b15, fixing RTD builds by renaming Matter SDK docs, unignoring migrated docs, and failing on warnings; confdb ToC warnings remained in #5200.
76%
#400 ci: make RTD use `make docs` starbase closed PR #400 (make Read the Docs use `make docs`) was closed unmerged and superseded by PR #401, which was merged as commit faccd06, configuring RTD's html build to run `make docs DOCS_VENVDIR=...`.
76%
#401 ci: make RTD use `make docs` starbase merged Merged as commit faccd06, updating Read the Docs to build through `make docs` with the RTD virtualenv and output paths.
76%
#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.
76%
#749 ci(docs): switch RTD build to use uv craft-providers merged Merged PR #749 (commit 83117dd) switched Read the Docs builds to uv-managed environment creation and dependency installation.
74%
#6295 docs: fix version numbering snapcraft merged Merged #6295 (commit 8456b4421), fixing docs version numbering to use Read the Docs branch metadata and keep local and RTD builds consistent.
72%
#103 grant integration access to RTD.com rockcraft closed Read the Docs integration access was granted, enabling the migrated RTD project to build documentation from repository commits.
72%
#50 Documentation on Read the Docs is outdated craft-cli closed 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.
72%
#383 docs: fail on RTD warnings starbase merged Merged PR #383 in commit f67abd7, setting Sphinx fail_on_warning so Read the Docs builds fail on documentation warnings instead of silently ignoring them.
71%
#54 fix(docs): make readthedocs build correctly craft-platforms merged Merged PR #54 via commit 16406ff, correcting the Read the Docs configuration so the documentation builds successfully.
71%