sphinx-notfound-page

What it is and what it does

sphinx-notfound-page is a Sphinx extension that automates the creation of a 404 error page for documentation sites. When a reader lands on a missing page, this extension serves a custom 404 page with absolute URLs hardcoded, ensuring navigation links work correctly even when the page doesn't exist. The extension integrates directly into Sphinx's build process via a simple configuration entry.

The package depends only on Sphinx itself and supports Python 3.8 through 3.12. It is marked Production/Stable and has been in use since 2019, though recent maintenance activity has slowed. The extension is particularly useful for documentation hosted on Read the Docs or similar platforms where 404 handling needs to be explicit and reliable.

Use it for:

• Build a custom 404 page for Sphinx documentation that guides users back to the main site with working links.
• Ensure broken documentation links in search engines or external references land on a helpful error page instead of a generic server error.
• Customize the 404 experience for multi-version or multi-language documentation builds where navigation must remain functional.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that generates a custom 404 error page with absolute URLs hardcoded for documentation sites.

Yes, if you maintain Sphinx documentation and need a reliable 404 page. The extension is lightweight, has no security vulnerabilities, and integrates with minimal configuration. The aging maintenance status is not a blocker for a stable, focused tool—but monitor the repository if you rely on it for production documentation.

Install

sphinx-notfound-page on PyPI

pip install sphinx-notfound-page

uv add sphinx-notfound-page

poetry add sphinx-notfound-page

Installing sphinx-notfound-page

Before you install

Low install friction with a single runtime dependency on sphinx. Maintenance status is aging—last commit was 2026-01-28 and no release in 563 days—but the repository remains active and the package is marked Production/Stable.

License in practice

Licensed under MIT (permissive), so you can use and modify this extension freely in commercial and private projects without restriction.

Quickstart

pip install sphinx-notfound-page

Then in conf.py:
extensions = ['notfound.extension']

Verify before relying

• Whether the 404 page generation works correctly with all Sphinx theme variations and configurations.
• How the extension handles dynamic documentation builds or multi-version documentation setups.

Package facts

Evidence: sphinx_notfound_page-1.1.0-py3-none-any.whl

Keywords: notfound, 404, page, sphinx, documentation

Tags

More Sphinx packages