← Back to issue list

docs: update sphinx to 6

View original Github issue

Metadata

Project
starbase
Number
#73
Type
pull request
State
merged
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Merged a one-line documentation update to upgrade Sphinx to version 6. Approved and passed CI. This serves as an intermediate step toward a future Sphinx 7 upgrade, currently blocked by the Furo theme.

Suggested action:

No scores available.

Issue body

Furo currently blocks us from updating to sphinx 7 https://github.com/pradyunsg/furo/pull/653 - [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `tox`? -----

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged a one-line documentation update to upgrade Sphinx to version 6. Approved and passed CI. This serves as an intermediate step toward a future Sphinx 7 upgrade, currently blocked by the Furo theme.
qwen3.6-35b-a3b-mtp-q6 Merged a pull request updating Sphinx dependencies to version 6. This intermediate upgrade prepares the codebase for a future Sphinx 7 release, pending a separate Furo compatibility fix.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
80%
#501 docs: update Sphinx theme craft-parts merged Updated Sphinx documentation theme. Merged after single reviewer approval and passing CI checks. Changed seven files with 151 additions and 20 deletions.
78%
#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.
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).
74%
#12 docs: Basic sphinx docs starbase merged Merged basic Sphinx documentation adding 208 lines across 10 files. Approved by one reviewer and merged despite three unresolved comments. A noted test failure was resolved in PR #13.
74%
#734 chore(deps): update documentation dependencies craft-parts closed Merged automated updates for documentation dependencies. Upgraded Sphinx to 7.3.7, furo to 2024.5.6, sphinx-autobuild to 2024.4.16, and sphinx-autodoc-typehints to 2.1.0. CI passed and review was approved prior to merge.
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%
#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.
74%
#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.
74%
#983 docs: update links rockcraft merged Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures.
73%