← Back to issue list

docs: use Sphinx + Readthedocs

View original Github issue

Metadata

Project
fetch-service
Number
#163
Type
pull request
State
merged
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

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.

Suggested action: —

No scores available.

Issue body

These series of commits update the docs to a "proper" Sphinx project (using the canonical-sphinx extension), and hook them up to get readthedocs builds. The build for this PR itself is here: https://canonical-fetch-service--163.com.readthedocs.build/en/163/ (note that you need to be logged in to access it).

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b — — 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.

Update history

Date Change
created

Related issues

Issue Project State Summary Similarity
#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.
86%
#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.
84%
#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).
83%
#249 docs: use canonical-sphinx extension craft-cli merged Merged following approval by two reviewers. The change integrates the canonical-sphinx extension into the documentation build system, updating 22 files and removing over 1000 lines of legacy configuration.
83%
#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.
78%
#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.
78%
#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.
78%
#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.
77%
#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.
77%
#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.
77%