Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/readthedocs/sphinx-notfound-page

Create a custom 404 page with absolute URLs hardcoded
https://github.com/readthedocs/sphinx-notfound-page

404 notfound readthedocs sphinx sphinx-extension

Last synced: 4 days ago
JSON representation

Create a custom 404 page with absolute URLs hardcoded

Host: GitHub
URL: https://github.com/readthedocs/sphinx-notfound-page
Owner: readthedocs
License: mit
Created: 2019-01-19T11:30:38.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2023-12-19T17:27:48.000Z (11 months ago)
Last Synced: 2024-01-21T13:58:59.491Z (10 months ago)
Topics: 404, notfound, readthedocs, sphinx, sphinx-extension
Language: Python
Homepage: https://sphinx-notfound-page.readthedocs.io/
Size: 732 KB
Stars: 40
Watchers: 7
Forks: 33
Open Issues: 8
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        |Build| |PyPI version| |Docs badge| |License|

sphinx-notfound-page

====================

Create a custom 404 page with absolute URLs hardcoded.

Installation

------------

.. code-block:: bash

   pip install sphinx-notfound-page

Configuration

-------------

Add this extension in your ``conf.py`` file as:

.. code-block:: python

   extensions = [

    # ... other extensions here

    'notfound.extension',

   ]

Documentation

-------------

Check out the full documentation at https://sphinx-notfound-page.readthedocs.io/

Thanks

------

**Strongly** based on @ericholscher's solution from https://github.com/readthedocs/readthedocs.org/issues/353

.. |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