File: README.rst

package info (click to toggle)
sphinx-notfound-page 1.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 920 kB
  • sloc: python: 699; makefile: 15
file content (53 lines) | stat: -rw-r--r-- 1,362 bytes parent folder | download | duplicates (2)
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
|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