docs: update build procedure and fix warning
Metadata
Current evaluation
Merged updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects.
Suggested action: —
No scores available.
Issue body
Build api docs in conf.py so it is all in one place for readthedocs
to make use of.
Signed-off-by: Sergio Schvezov <sergio.schvezov@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 updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Consolidated API documentation build configuration into conf.py for ReadTheDocs, resolving a build warning. Author noted the changes should propagate to craft-* projects. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #554 docs: update docs subproject readme | starbase | merged | Merged. Updated the docs subproject readme to correct outdated instructions and clarify that the documentation targets craft apps contributors. Approved by reviewers and passed all CI checks. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #2186 docs: fix build errors | charmcraft | merged | Merged a one-line documentation fix to resolve recent build errors. Approved by two reviewers. Remaining build issues were subsequently addressed in craft-parts pull request 1021. | |
| #114 docs: update readme information | debcraft | merged | Merged after two approvals and passing CI checks. Updates the README with basic usage information consistent with other craft tools, resolving DEBCRAFT-25. Review feedback was incorporated prior to merge. | |
| #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. | |
| #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. | |
| #949 docs: update and complete the step execution environment | craft-parts | merged | Merged documentation update adding missing step execution environment variables and noting CRAFT_TARGET_ARCH and CRAFT_ARCH_TRIPLET deprecation. Resolves #948. Approved by two reviewers, passed CI, and modified three files. | |
| #2070 docs: fix build errors in craft-parts | charmcraft | closed | Merged to resolve documentation build errors in craft-parts. Changes fix ref and label issues, with some dependencies on an upstream PR. Integrated directly by the maintainer without reviewer comments or CI checks. | |
| #5537 docs: update build provider procedures | snapcraft | merged | Merged documentation update to build provider procedures, resolving issue #5519. Approved by two reviewers and passed most CI checks despite minor integration test failures. Changes span four files with 100 lines added and 98 removed. | |
| #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. |