← Back to issue list

docs: declare slug in config

View original Github issue

Metadata

Project
craft-parts
Number
#1661
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

PR #1661 merged: added the project slug to docs/conf.py so Canonical Sphinx configures sphinx-notfound-page, restoring the custom 404 page on documentation.ubuntu.com/craft-parts.

Resolution: closed resolved

Reason: The PR was merged by maintainer jahn-junior after 2 approving reviews, landing a one-line docs/conf.py change declaring the slug; the PR build and live 404 pages confirmed sphinx-notfound-page now works. The single unresolved comment and the lint/s390x CI failures were noted by @mr-cal as unrelated.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you followed the guidelines for contributing? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? - [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? --- Canonical Sphinx uses this to configure the sphinx-notfound-page extension. Live 404 page: https://documentation.ubuntu.com/craft-parts/oops PR build 404 page: https://canonical-ubuntu-documentation-library--1661.com.readthedocs.build/craft-parts/1661/oops

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved PR #1661 merged: added the project slug to docs/conf.py so Canonical Sphinx configures sphinx-notfound-page, restoring the custom 404 page on documentation.ubuntu.com/craft-parts.
stealth/space-bunny-alpha — closed resolved Merged #1661, adding the Sphinx project slug so Canonical Sphinx can configure sphinx-notfound-page and render the custom 404 page.
qwen/qwen3.6-35b-a3b — — Merged. Declares the slug in the configuration to enable the sphinx-notfound-page extension for Canonical Sphinx. Approved by two reviewers and merged after CI checks passed.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 85
needs review Declares a slug in the Sphinx configuration to enable the notfound-page extension. Currently pending maintainer review with one failing lint check.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Adds a slug config value to Sphinx settings to enable proper 404 page routing via the sphinx-notfound-page extension. Currently pending initial maintainer review.

Update history

Date Change
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#1158 docs: declare slug in config craft-application merged Merged PR #1158 (1 file, +2/-2) declared the project slug in the Sphinx docs config so Canonical Sphinx can enable sphinx-notfound-page and serve a custom 404 page at /craft-application/oops.
92%
#470 docs: declare slug in config craft-cli merged Merged PR #470 added the craft-cli documentation slug to Sphinx config, enabling sphinx-notfound-page to serve Canonical's custom 404 page.
90%
#244 docs: declare slug in config craft-archives merged Merged PR #244 added slug = "craft-archives" to docs/conf.py so sphinx-notfound-page can configure the documentation 404 page.
90%
#583 docs: declare slug in config starbase merged Merged #583, adding the docs slug to Sphinx config so Canonical Sphinx can resolve the custom sphinx-notfound-page 404 route.
89%
#261 docs: declare slug in config craft-platforms merged PR #261 merged as commit 390d4b3, adding `slug = "craft-platforms"` to docs/conf.py for the sphinx-notfound-page extension so the docs 404 page resolves to the project slug. Approved with all CI (incl. sphinx) green.
88%
#993 docs: declare slug in config craft-providers merged Merged in commit 57d57af, declaring the project slug in Sphinx config so Canonical Sphinx can configure its custom 404 page.
88%
#207 docs: declare slug in config craft-grammar merged PR #207 merged, adding `slug` to craft-grammar's Sphinx conf.py so Canonical Sphinx enables sphinx-notfound-page; the custom 404 page now renders on live and PR builds. 2 approvals, all CI checks green.
87%
#757 feat: add docs slug to build exception craft-parts closed Superseded by merged PR canonical/craft-parts#758 (commit cb79f762), adding documentation slugs to build errors; released in craft-parts 1.33.0.
74%
#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.
73%
#603 feat: add doc_slug to init rockcraft merged Merged PR #603 added doc_slug to init for reference-documentation messages and enabled it for flask-framework; landed as commit 56b3ecdb.
71%