Guide about custom 404 pages #5738
Merged
+27
−0
Conversation
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
Small guide mentioning how Read the Docs find the 404.html file and suggesting sphinx-notfound-page to generate this HTML easily.
stsewd
reviewed
May 29, 2019
|
|
||
| In case you don't want to deal with these links manually, | ||
| or you want to use the same style for the 404 page than your theme in an easy way, | ||
| you can use the `sphinx-notfound-page`_ extension. |
There was a problem hiding this comment.
Are we in the point to recommend the extension? I think there was some discussion to wait to have something solid fist.
There was a problem hiding this comment.
I think that we are in that point now. We have been testing it for a while now in our own docs and there are people already using it. Also, it has tests and its own docs now.
There was a problem hiding this comment.
This is after releasing v0.4, though.
ericholscher
reviewed
Jun 6, 2019
Co-Authored-By: Eric Holscher <[email protected]>
humitos
force-pushed
the
humitos/custom-404-docs
branch
from
1fd11cb to
8444540
Compare
|
I accepted all the suggestions. Feel free to merge if you consider. |
|
@stsewd @ericholscher are we happy merging this at this point? |
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.
Communicate to the users that adding a
404.htmlin their root directory of the docs, will make Read the Docs to find it and serve it when a 404 happensAlso, suggest the usage of the
sphinx-notfound-pageextension.