1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
Generate 404 Not Found Pages Automatically for Sphinx Docs
==========================================================
``sphinx-notfound-page`` is a Sphinx_ extension to create custom 404 pages and help you to generate proper resource links (js, css, images, etc) to render the page properly.
This extension was originally developed to be used on `Read the Docs`_ but it can be used in other hosting services as well.
Online documentation:
https://sphinx-notfound-page.readthedocs.io/
Source code repository (and issue tracker):
https://github.com/readthedocs/sphinx-notfound-page/
Badges:
|Build| |PyPI version| |Docs badge| |License|
Why do I need this extension?
-----------------------------
Sphinx does not create a 404 page by default.
Although, you can create it by adding a simple ``404.rst`` file to your docs but...
If you are reading this documentation,
you may already experienced the problem that all your images do no load,
all your styles are broken and all the javascript events does not work,
when accessing the 404 page of your documentation.
So, if you want to have a nice custom 404 page,
you will probably want to use this extension to avoid this headache
and let the extension handle these URLs properly for you.
.. tabs::
.. tab:: 404 page *using* this extension
.. figure:: 404-using-this-extension.png
:align: center
Example of 404 page *using* ``sphinx-notfound-page``.
.. tab:: 404 page *without* this extension
.. figure:: 404-without-this-extension.png
:align: center
Example of 404 page *without using* ``sphinx-notfound-page``.
.. toctree::
:maxdepth: 1
:caption: Contents
installation
configuration
how-it-works
get-involved
who-is-using-it
faq
.. toctree::
:maxdepth: 1
:caption: API Reference
autoapi/notfound/index
.. _Sphinx: https://www.sphinx-doc.org/
.. _Read the Docs: https://readthedocs.org
.. |Build| image:: https://circleci.com/gh/readthedocs/sphinx-notfound-page.svg?style=svg
:target: https://circleci.com/gh/readthedocs/sphinx-notfound-page
:alt: Build status
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-notfound-page.svg
:target: https://pypi.org/project/sphinx-notfound-page
:alt: Current PyPI version
.. |Docs badge| image:: https://readthedocs.org/projects/sphinx-notfound-page/badge/?version=latest
:target: https://sphinx-notfound-page.readthedocs.io/en/latest/?badge=latest
:alt: Documentation status
.. |License| image:: https://img.shields.io/github/license/readthedocs/sphinx-notfound-page.svg
:target: LICENSE
:alt: Repository license
|
