← Back to issue list

docs: fix readthedocs documentation generation

View original Github issue

Metadata

Project
craft-parts
Number
#219
Type
pull request
State
merged
Author
cmatsuoka
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: PR #219 was approved by a reviewer and merged into main as commit c70294ee (merge commit 996ed24e) by maintainer cmatsuoka. The resulting changelog entry "Fix readthedocs documentation generation" appears under release 1.7.0 (2022-05-20) in docs/reference/changelog.rst, confirming the fix shipped.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Install missing packages in readthedocs environment and add changelog to the documentation index. Removing python-apt from setup packages was also required because the version of python-apt in PyPI is outdated and readthedocs tries to install it over the existing version previously installed from sources. This shouldn't be a problem because applications are also required to install python-apt. Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com> - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #219 fixed ReadTheDocs generation by installing missing packages, indexing the changelog, and removing outdated python-apt from setup dependencies.
qwen/qwen3.6-35b-a3b — — Merged. Resolved ReadTheDocs build failures by installing missing environment packages, adding the changelog to the documentation index, and removing python-apt from setup to prevent version conflicts. Approved and passed CI.
qwen3.6-35b-a3b-mtp-q6 — — Merged a fix for ReadTheDocs generation by installing missing environment packages, adding a changelog to the documentation index, and removing the outdated python-apt dependency to prevent build conflicts.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-parts#56 (confidence 30%)

    Earlier docs/readthedocs config work (commit997c79dd, f92106e5) that added .readthedocs.yaml, preceding this build-failure fix.

Related issues

Issue Project State Summary Similarity
#4258 docs: enable RTD builds snapcraft merged Merged PR #4258 enabled Read the Docs builds by adding documentation build configuration; merged as commit 4d0d75112.
76%
#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.
75%
#258 docs: update readme and template, fix build error starbase merged Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build.
74%
#4864 build(docs): fix version in rtd builds snapcraft merged PR #4864 merged as commit 3d05bf373: adds a post_checkout `git fetch --tags --unshallow` step to .readthedocs.yaml and installs snapcraft explicitly so docs show the correct version on RTD builds.
72%
#586 docs: fix incorrect version in documentation rockcraft merged Merged in #586 via commits 0ffc2395 and d5da1878, fixing #584 by fetching tags for Read the Docs and labeling unreleased docs as dev.
71%
#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.
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%
#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.
70%
#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.
70%
#36 docs: move API gen to conf.py for RTD to pick up craft-cli merged Merged in craft-cli#36 (commit 7e35464, merge 35267d4), moving sphinx-apidoc into docs/conf.py so Read the Docs builds the API reference; typos were also fixed.
70%