← Back to issue list

docs: declare slug in config

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: The pull request itself was the fix and it was merged into the main branch with all CI checks passing (lint, fast/slow tests, policy checks) and one approving review. Its change adds the slug declaration needed by Canonical Sphinx's sphinx-notfound-page configuration.

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-application/oops PR build 404 page: https://canonical-ubuntu-documentation-library--1158.com.readthedocs.build/craft-application/1158/oops

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #1158 (commit 9fcde8c7) added `slug = "craft-application"` to docs/conf.py so Canonical Sphinx's sphinx-notfound-page extension renders a working 404 page.
stealth/space-bunny-alpha — closed resolved Merged docs PR #1158 (commit 9fcde8c7) added `slug = "craft-application"` to docs/conf.py so Canonical Sphinx configures sphinx-notfound-page, fixing the docs 404 page.
stealth/space-bunny-alpha — closed resolved Merged PR #1158 added a slug declaration to the docs config, enabling Canonical Sphinx to configure sphinx-notfound-page and display custom 404 pages.
qwen/qwen3.6-35b-a3b — — Merged after approval and passing all CI checks. The change declares the slug in config to enable Canonical Sphinx to configure the sphinx-notfound-page extension for custom 404 pages.
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 custom 404 pages. All CI checks pass, awaiting maintainer review.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Declares a slug in the Sphinx configuration to enable the sphinx-notfound-page extension for consistent 404 pages. Currently pending CI completion and initial maintainer review.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Configures Sphinx slug to standardize 404 pages across Canonical documentation. Currently awaiting maintainer review with CI checks still pending.

Update history

Date Change
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#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.
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.
91%
#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.
89%
#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%
#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.
87%
#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.
86%
#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.
86%
#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.
72%