Docs: create nice 404 pages #3444
Merged
Conversation
This file contains 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
Currently, when a user arrives at a 404 page, Read the Docs shows the default Maze Found page without context about the setuptools project itself. This extension, `sphinx-notfound-page`, creates a `404.html` page with the same style as the rest of the documentation pages that Read the Docs will serve instead of the default Maze Found one.
abravalheri
reviewed
Aug 1, 2022
| @@ -90,6 +90,7 @@ docs = | |||
| jaraco.packaging >= 9 | |||
| rst.linker >= 1.9 | |||
| jaraco.tidelift >= 1.4 | |||
| sphinx-notfound-page == 0.8.3 | |||
There was a problem hiding this comment.
I did a merge to fix the conflict (and decided to leave the version pinned because the extension haven't achieved 1.0 yet).
There was a problem hiding this comment.
Sounds good! It has been pretty stable and we don't have plans for big changes under the radar --but I think it's fine to use the pinned version as a way of self protection just in case 😄
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.
Summary of changes
Currently, when a user arrives at a 404 page, Read the Docs shows the default Maze Found page without context about the setuptools project itself.
This extension,
sphinx-notfound-page, creates a404.htmlpage with the same style as the rest of the documentation pages that Read the Docs will serve instead of the default Maze Found one.This PR suggests installing this extension so readers of this documentation have nicer UX when dealing with not found pages. I st up a Read the Docs project as example to show the behavior, take a look at this not found page https://humitos-setuptools.readthedocs.io/en/docs-notfound-page/notfound
Let me know if there is any modification you want me to do or any feedback you may have.
Example
Pull Request Checklist
changelog.d/.(See documentation for details)