docs: fix readthedocs documentation generation
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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 issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #586 docs: fix incorrect version in documentation | rockcraft | merged | Merged to resolve #584. Configured ReadTheDocs to fetch tags and updated non-release documentation to display dev instead of misleading release strings. Approved by two reviewers with passing CI. | |
| #383 docs: fail on RTD warnings | starbase | merged | Merged configuration to fail CI builds on ReadTheDocs warnings, resolving a recurring issue where documentation warnings were silently ignored. Approved by two reviewers and passed all checks. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage. | |
| #51 docs: update readthedocs recipe | craft-cli | merged | Merged by maintainer sergiusens, this pull request updates the ReadTheDocs recipe and resolves issue #50. Approved by one reviewer, it passed CI checks and modified two files with 17 additions and 10 deletions. | |
| #5957 docs: fix typo in ROS version names | snapcraft | merged | Merged a documentation update correcting a typo in ROS version names. Approved by two reviewers, modified one file, and passed all CI checks. A reviewer confirmed ReadTheDocs was misreporting the build status. | |
| #387 readme: update readthedocs link | craft-parts | merged | Merged a single-file update to the README that corrected the ReadTheDocs documentation link. The change received approval from one reviewer, had no unresolved comments, and required no CI checks. | |
| #25 Fix path in readthedocs yaml | imagecraft | merged | Merged a single-line correction to the readthedocs.yaml path, resolving ReadTheDocs build failures. The change passed CI checks and was accepted without review comments. | |
| #419 docs: update / remove duplicate content | rockcraft | merged | Merged to update and remove duplicate documentation, fixing issue #405. Approved by two reviewers despite ReadTheDocs build warnings about undefined labels. Reduced 57 lines across 5 files. | |
| #81 docs: initialise docs | starflow | merged | Merged documentation initialization, establishing a basic ReadTheDocs structure with public PR builds and private main builds until content is added. Approved by two reviewers, passed all CI checks, and added 2225 lines across 14 files. | |
| #2299 docs: fix formatting issues | charmcraft | merged | Merged documentation formatting fixes resolving local build errors. Approved by two reviewers with minimal changes (+3/-1 across two files). Merged despite failing snap-build CI checks. |