docs: move API gen to conf.py for RTD to pick up
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: PR #36 was merged as 35267d4, with implementation commit 7e35464. It moved sphinx-apidoc generation into Sphinx's conf.py, enabling Read the Docs to build the API reference.
Evaluated by: mr-cal-bot
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged sphinx-apidoc generation into Sphinx's conf.py so Read the Docs can build the API reference; also corrected documentation typos. | |
| 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. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #65 docs: fix sphinx doc generation and update docstrings | craft-parts | merged | Merged in canonical/craft-parts#65 via a5373f23, fixing Sphinx type-hint import cycles and adding missing docstring parameter descriptions. | |
| #332 docs: use conf.py to create docs common directories | rockcraft | merged | Merged #332 as 0e673825, moving shared docs directory creation into docs/conf.py; follow-up aa9ea95 added product_tag and fixed the Sphinx build failure. | |
| #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. |