← Back to issue list

docs: import Sphinx scaffolding for documentation work

View original Github issue

Metadata

Project
snapcraft
Number
#4055
Type
pull request
State
merged
Author
dboddie
Labels
Created
Updated
Closed

Current evaluation

Merged after review approval and passing CI checks. Imports Sphinx scaffolding for documentation, includes the requested tox configuration, and resolves the missing python-apt dependency for the docs build.

Suggested action:

No scores available.

Issue body

- [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 after review approval and passing CI checks. Imports Sphinx scaffolding for documentation, includes the requested tox configuration, and resolves the missing python-apt dependency for the docs build.
qwen3.6-35b-a3b-mtp-q6 Merged into main. Imported Sphinx scaffolding for documentation, added tox configuration, resolved missing python-apt dependency for the docs target, and deferred spread test fix to follow-up PR #4102.
qwen3.6-35b-a3b-mtp-q6 Merged to main. Added Sphinx scaffolding for documentation, included requested tox configuration, resolved missing python-apt dependency for docs, and deferred a spread test fix to PR #4102.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#434 docs: use tox for sphinx docs craft-parts closed Closed without review or merge, indicating abandonment. The PR proposed switching Sphinx documentation builds to tox, altering 12 files. No comments, reviewers, or CI checks were recorded.
75%
#4766 docs: use canonical-sphinx snapcraft merged Merged documentation update switching to canonical-sphinx. Consolidated requirements files and added docs_requires to setup.py. Approved by two reviewers with passing CI checks.
75%
#163 docs: use Sphinx + Readthedocs fetch-service merged Merged documentation migration to Sphinx using the canonical-sphinx extension and integrated ReadTheDocs for automated builds. Approved by two reviewers, modifying eight files with 206 additions and 102 deletions.
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.
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.
73%
#559 docs: use canonical-sphinx rockcraft merged Merged documentation update to adopt canonical-sphinx. Added the dependency to setup.cfg and regenerated requirements-doc.txt by freezing the doc environment. Approved by two reviewers with passing CI across seven files.
73%
#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).
73%
#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.
73%
#209 docs: use canonical-sphinx starbase merged Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, modifying two files with 45 additions and 36 deletions.
72%
#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.
72%