← Back to issue list

docs: use tox for sphinx docs

View original Github issue

Metadata

Project
craft-parts
Number
#434
Type
pull request
State
closed
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

Closed unmerged as redundant: canonical/craft-parts#433 merged the broader Starbase tox setup in 7dbf0405; equivalent Sphinx support landed via canonical/snapcraft#4273 at d25b49d63.

Resolution: closed superseded

Reason: canonical/craft-parts#433 merged commit 7dbf0405, establishing the tox configuration that replaced this narrower proposal. The tracked resolution also cites canonical/snapcraft#4273 (d25b49d63) as delivering equivalent tox-based Sphinx support.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed superseded Closed unmerged as redundant: canonical/craft-parts#433 merged the broader Starbase tox setup in 7dbf0405; equivalent Sphinx support landed via canonical/snapcraft#4273 at d25b49d63.
stealth/space-bunny-alpha — closed resolved Tox-based Sphinx documentation support was delivered by merged canonical/snapcraft#4273 (commit d25b49d63); the original PR’s merge reference was not shown.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged to update Sphinx documentation generation to use tox. The maintainer-authored change streamlined the build process and was accepted without review comments.

Update history

No update history recorded yet.

Related work

  • Superseded By: canonical/craft-parts#433 (confidence 94%)

    The merged Starbase tox setup replaced this narrower documentation proposal.

  • Related To: canonical/snapcraft#4273 (confidence 85%)

    Merged commit d25b49d63 delivered equivalent tox-based Sphinx support.

Related issues

Issue Project State Summary Similarity
#4766 docs: use canonical-sphinx snapcraft merged Merged in canonical/snapcraft#4766 (678d5f50f), switching docs to canonical-sphinx, adding setup.py docs_requires, and consolidating frozen dependencies in docs/requirements.txt.
75%
#720 docs: use canonical-sphinx craft-parts merged Merged PR #720 as commit 278feb8d, migrating craft-parts docs to canonical-sphinx and removing legacy configuration across three files.
75%
#4055 docs: import Sphinx scaffolding for documentation work snapcraft merged Merged as commit ebc549ed4 ("docs: import Sphinx scaffolding for documentation work (#4055)"), adding Starbase-derived Sphinx docs scaffolding (docs/conf.py, tox docs config, 13 files, +513 lines).
74%
#65 docs: fix sphinx doc generation and update docstrings craft-parts merged Merged in canonical/craft-parts#65 via a5373f23, fixing Sphinx type-hint import cycles and adding missing docstring parameter descriptions.
73%
#24 some general docs improvements starbase merged Merged in canonical/starbase#24, adding Sphinx linting and autobuild, strict docs builds, Ubuntu-font CSS, and renamed docs tox environments.
72%
#562 docs: update to canonical-sphinx craft-providers merged Merged PR (commit 9897239) enabled the canonical-sphinx docs extension and removed sphinx-docs-starter-pack submodule references in craft-providers. Leftover submodule dir was later cleaned up in #713.
72%
#209 docs: use canonical-sphinx starbase merged Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx.
72%
#5033 docs: document tox builds snapcraft merged Merged #5033 in commit 8faa6d54e, documenting tox builds in HACKING.md and removing snapcraft_legacy from autobuild targets.
71%
#325 docs: use canonical-sphinx craft-application merged Merged PR #325 in commit 8ca97e1a, migrating the docs to canonical-sphinx and removing unused extensions and configuration.
71%
#1061 tools: bring tox and linting from starbase charmcraft closed Closed unmerged after years of inactivity; its tox import landed separately in canonical/charmcraft#1062 via commit 4ed52927.
71%