some general docs improvements
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
The changes are all doc-related and are split over separate commits:
- add `sphinx-lint` in standard linting
- add css to use the Ubuntu font (css from rockcraft)
- tentatively treat warnings as errors in sphinx-build. If it becomes too onerous projects can remove the flag, but it's the kind of thing where it's easier to have from the beginning
- add `sphinx-autobuild` to have the interactive server when editing the docs
- rename the tox envs to `docs-build` and `docs-autobuild` to keep consistent with the other envs; this one I did mostly out of "pedantry" but we can drop if we decide to keep things as-is.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation improvements including sphinx-lint integration, Ubuntu font CSS, sphinx-build warning-as-error flag, sphinx-autobuild addition, and tox environment renaming for consistency. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1711 feat: add basic sphinx docs | charmcraft | merged | Merged to implement a Sphinx documentation project and basic reference docs for auto-generating juju.is content. Approved by two reviewers, resolves #1692, and updates 25 files. | |
| #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. | |
| #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). | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #4055 docs: import Sphinx scaffolding for documentation work | snapcraft | merged | 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. | |
| #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. | |
| #4128 docs: set sphinx autobuild-docs to watch the correct directories | snapcraft | merged | 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. |