docs: declare slug in config - #1158
Merged
Merged
Conversation
Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx documentation configuration to explicitly declare the project slug, which Canonical Sphinx uses to configure the sphinx-notfound-page extension so 404 (“oops”) pages render consistently with Canonical’s standard.
Changes:
- Define
slug = "craft-application"indocs/conf.pyto support Canonical Sphinx’s notfound-page configuration.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Updated the project slug comment for clarity. Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com>
Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com>
Signed-off-by: JJ Coldiron <jj.coldiron@canonical.com>
lengau
approved these changes
Aug 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
make lint && make test?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