Skip to content

Guide about custom 404 pages #5738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/guides/custom-404-page.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Use custom ``404 Not Found`` page on my project
===============================================

If you want your project to use a custom page for not found pages instead of the "Maze Found" default one,
you can put a ``404.html`` at the top level of your project's HTML output.

When a 404 is returned, Read the Docs checks if there is a ``404.html`` in the root of your project's output and uses it if it exists.

As the ``404.html`` will be returned for all the URLs where the real page was not found,
all its resources URLs and links must be absolute (starting with a ``/``),
otherwise they will not work when a user clicks on them.

In case you don't want to deal with these links manually,
or you want to use the same style as your theme,
you can use the `sphinx-notfound-page`_ extension.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we in the point to recommend the extension? I think there was some discussion to wait to have something solid fist.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is after releasing v0.4, though.



Using ``sphinx-notfound-page`` extension
----------------------------------------

The ``sphinx-notfound-page`` extension automatically creates the proper URLs for your 404 page.
Once the extension is installed, it will generate the default 404 page for your project.
See its documentation_ for how to install and custom it.


.. _sphinx-notfound-page: https://pypi.org/project/sphinx-notfound-page
.. _documentation: https://sphinx-notfound-page.readthedocs.io/