Installation

Install the package

from PyPIfrom GitHub

$ pip install sphinx-notfound-page

Once we have the package installed, we have to configure it on our Sphinx documentation. To do this, add this extension to your Sphinx’s extensions in the conf.py file.

# conf.py
extensions = [
     # ... other extensions here
     'notfound.extension',
]

After installing the package and adding the extension in the conf.py file, you can build your documentation again and you will see a new file called 404.html in your documentation’s build output.

Warning

If you open the 404.html file on the browser, you will see that all of the images and css does not display properly. This is because all the URLs are absolute and since the file is being rendered from file:// in the browser, it does not know where to find those resources.

Do not worry too much about this, this is the expected behavior and those resources will appear once the docs are deployed.

If you can’t see the 404.html file using a local simple web server, it is most likely because they often don’t support requests for 404 codes. Refer to the Frequently Asked Questions for more information.