Configuration
The default settings generate the most commonly-used URL pattern on Read the Docs:
if you have a resource at _static/js/logic.js
and you generate a 404 page with the default settings,
the URL for that resource will be /en/latest/_static/js/logic.js
.
For other use cases, you can customize these configuration options in your conf.py
file:
- notfound_template
Template used to render the
404.html
generated by this extension.Default:
'page.html'
Type: string
- notfound_context
Context passed to the template defined by
notfound_template
.Default:
{ 'title': 'Page not found', 'body': '<h1>Page not found</h1>\n\nThanks for trying.', }
Type: dict
Note
If you prefer, you can create a file called
404.rst
and use reStructuredText to create the context of your404.html
page. Add the:orphan:
metadata to the top of404.rst
, to silence the spuriousdocument isn't included in any toctree
warning.
- notfound_pagename
Page name generated by the extension.
Default:
'404'
Type: string
- notfound_urls_prefix
Prefix added to all the URLs generated in the 404 page.
Default:
'/en/latest/'
Type: string
Warning
Make sure this config starts and ends with a
/
. Otherwise, you may have unexpected behaviours.Tip
The prefix can be completely removed by setting it to
None
.
- notfound_default_language
Language used as default to generate all links to the resources.
Default:
READTHEDOCS_LANGUAGE
environment variable, if set, else'en'
Type: string
Note
All links generated will have this prefix (e.g.
/en/
). This setting works withnotfound_default_version
to create a prefix for all URLs.Deprecated since version 0.5:
notfound_default_language
is deprecated. Usenotfound_urls_prefix
instead
- notfound_default_version
Version used as default to generate all links to the resources.
Default:
READTHEDOCS_VERSION
environment variable, if set, else'latest'
Type: string
Note
All links generated will have this prefix (e.g.
/latest/
). This setting works withnotfound_default_language
to create a prefix for all URLs.Deprecated since version 0.5:
notfound_default_version
is deprecated. Usenotfound_urls_prefix
instead
- notfound_no_urls_prefix
URL prefixes skipped or included.
Default:
False
.Type: bool
Note
If this option is set to
True
, the extension omits any prefix values from the URLs, including explicit values fornotfound_default_language
andnotfound_default_version
.Deprecated since version 0.5:
notfound_no_urls_prefix
is deprecated. Usenotfound_urls_prefix
instead