docs: move API gen to conf.py for RTD to pick up
Metadata
Current evaluation
Merged. Moved API documentation generation to conf.py to enable Read The Docs to build it automatically, with minor typo corrections. Approved and passed CI.
Suggested action: —
No scores available.
Issue body
Read The Docs can build the API documentation (reference) by moving
sphinx-apidoc to conf.py which is its entry point for building.
Some typos were also corrected.
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. Moved API documentation generation to conf.py to enable Read The Docs to build it automatically, with minor typo corrections. Approved and passed CI. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Moved sphinx-apidoc to conf.py to allow Read The Docs to automatically generate API documentation. Minor typos were also corrected. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1055 docs: fix canonical URL | rockcraft | merged | Merged documentation fix to update canonical URLs in conf.py. The change pulls correct versioned URLs from RTD, appends page paths, and excludes generated pages from the sitemap to improve SEO. Approved by reviewers and passed all CI checks. | |
| #4258 docs: enable RTD builds | snapcraft | merged | Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file. | |
| #400 ci: make RTD use `make docs` | starbase | closed | Merged to configure ReadTheDocs to use make docs for documentation builds. All CI checks passed and the change was accepted without review comments. | |
| #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. | |
| #219 docs: fix readthedocs documentation generation | craft-parts | merged | 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. | |
| #401 ci: make RTD use `make docs` | starbase | merged | Merged after approval by three reviewers and passing CI checks. Updated CI configuration to use make docs for ReadTheDocs builds, modifying two files with seven additions and three deletions. |