← Back to issue list

docs: set sphinx autobuild-docs to watch the correct directories

View original Github issue

Metadata

Project
snapcraft
Number
#4128
Type
pull request
State
merged
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Merged into main after two approvals and passing CI. Updates Sphinx autodoc configuration to monitor the correct directories, resolving issue #4123. Code coverage remained unchanged.

Suggested action:

No scores available.

Issue body

Fixes #4123 - [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [x] Have you successfully run `pytest tests/unit`? -----

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged into main after two approvals and passing CI. Updates Sphinx autodoc configuration to monitor the correct directories, resolving issue #4123. Code coverage remained unchanged.
qwen3.6-35b-a3b-mtp-q6 Merged into main. Updated Sphinx autobuild to monitor the correct directories for documentation builds, resolving issue #4123. Code coverage unchanged.
qwen3.6-35b-a3b-mtp-q6 Merged into main. Configures Sphinx autobuild to monitor the correct directories, resolving issue #4123. Code coverage unchanged.

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 after two approvals and passing CI. Fixed Sphinx doc generation by importing modules to resolve import cycles, and added missing parameter descriptions to docstrings across five files.
76%
#900 build(docs): update build, add sphinx sitemap, update site links rockcraft merged Merged after two approvals and passing all CI checks. Updates docs build config, switches Sphinx to dirhtml for sitemap generation, adds a sitemap, updates site links, and standardizes tooling across five files.
75%
#325 docs: use canonical-sphinx craft-application merged Merged documentation update to adopt canonical-sphinx and remove unused extensions. Approved by two reviewers, passed CI, and modified four files (+30/-83 lines).
75%
#346 docs: update sphinx-autodoc-typehints craft-parts merged Merged an update to sphinx-autodoc-typehints that resolved documentation generation failures caused by Pydantic incompatibility. Approved by reviewer, passed CI, and applied to a single file.
75%
#2323 build(docs): add sphinx sitemap charmcraft merged Merged following approval from two reviewers. Integrated sphinx-sitemap as a documentation dependency, updated conf.py to generate a sitemap during builds, and switched local builds to the dirhtml builder.
74%
#4367 docs: update sphinx theme snapcraft merged Merged documentation update for the Sphinx theme. Initial build failures were resolved by incorporating fixes from PR #4375 and minor adjustments. Approved by three reviewers, passed CI, and merged into main.
74%
#106 docs: use canonical-sphinx craft-archives merged Merged documentation update to use canonical-sphinx. Approved by two reviewers, passed CI and codecov checks, and successfully integrated into the codebase.
74%
#23 docs: use canonical-sphinx craft-grammar merged Merged after two approvals and passing CI. Updates documentation to use canonical-sphinx, modifying 7 files with a net reduction of 72 lines.
74%
#720 docs: use canonical-sphinx craft-parts merged Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, the change modifies three files, removing 167 lines and adding 45 to standardize the build configuration.
74%
#24 some general docs improvements starbase merged Merged documentation improvements adding sphinx-lint, Ubuntu font CSS, warning-as-error configuration, sphinx-autobuild, and renamed tox environments. Approved by one reviewer and successfully merged.
73%