docs: declare slug in config
Metadata
Current evaluation
Merged in commit 57d57af, declaring the project slug in Sphinx config so Canonical Sphinx can configure its custom 404 page.
Resolution: closed resolved
Reason: PR #993 was approved and merged as commit 57d57af. The change adds the slug needed by the sphinx-notfound-page extension; PR #995 separately fixed the unrelated lint failures.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Canonical Sphinx uses this to configure the sphinx-notfound-page extension.
Live 404 page: https://documentation.ubuntu.com/craft-providers/oops
PR build 404 page: https://canonical-ubuntu-documentation-library--993.com.readthedocs.build/craft-providers/993/oops
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md).
- [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [ ] I've successfully run `make lint && make test`.
- [ ] I've added or updated any relevant documentation.
- [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in commit 57d57af, declaring the project slug in Sphinx config so Canonical Sphinx can configure its custom 404 page. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #993, adding the project slug to Sphinx config so sphinx-notfound-page can render Canonical’s custom 404 page. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged. Declares the slug in Sphinx config to enable the sphinx-notfound-page extension for custom 404 pages. Approved by reviewers, passed CI, and an unrelated lint failure was overridden. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Configures sphinx-notfound-page extension by declaring a slug in the Sphinx config. Approved by two reviewers with most CI checks passing, though a file lint check is failing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Configures Canonical Sphinx to declare a slug for the sphinx-notfound-page extension, enabling a custom 404 page. Currently pending maintainer review with one lint check failing. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Configures Canonical Sphinx to declare a slug for the sphinx-notfound-page extension, enabling a custom 404 page. Currently pending maintainer review with one failing lint check and several pending CI jobs. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
85
|
needs review | Configures Canonical Sphinx slug for the sphinx-notfound-page extension to enable custom 404 pages. Currently pending maintainer review with one failing lint check on file formatting. |
Update history
| Date | Change |
|---|---|
| updated | |
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Related To:
canonical/craft-providers#995
(confidence 100%)
A maintainer identified this merged PR as fixing the unrelated lint failure that was overridden during #993.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #1661 docs: declare slug in config | craft-parts | merged | 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. | |
| #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. | |
| #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. | |
| #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. |