summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2024-10-11 13:50:51 +0200
committerSarah Boyce <42296566+sarahboyce@users.noreply.github.com>2024-10-11 17:14:02 +0200
commit263f7319192b217c4e3b1eea0ea7809836392bbc (patch)
treeb793693af850dbc6da00388f45ea3853205203a3 /docs/conf.py
parent9423f8b47673779049f603a7da271d183de7dc1d (diff)
Fixed docs build on Sphinx 8.1+.
Sphinx 8.1 added :cve: role, so there is no need to define it in Django: - https://github.com/sphinx-doc/sphinx/pull/11781 This also changes used URL to the one used by Python and soonish to be used by Sphinx itself: - https://github.com/sphinx-doc/sphinx/pull/13006
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index b72b1afcf5..9289e821fa 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,6 +13,8 @@ import functools
import sys
from os.path import abspath, dirname, join
+from sphinx import version_info as sphinx_version
+
# Workaround for sphinx-build recursion limit overflow:
# pickle.dump(doctree, f, pickle.HIGHEST_PROTOCOL)
# RuntimeError: maximum recursion depth exceeded while pickling an object
@@ -138,13 +140,15 @@ django_next_version = "5.2"
extlinks = {
"bpo": ("https://bugs.python.org/issue?@action=redirect&bpo=%s", "bpo-%s"),
"commit": ("https://github.com/django/django/commit/%s", "%s"),
- "cve": ("https://nvd.nist.gov/vuln/detail/CVE-%s", "CVE-%s"),
"pypi": ("https://pypi.org/project/%s/", "%s"),
# A file or directory. GitHub redirects from blob to tree if needed.
"source": ("https://github.com/django/django/blob/main/%s", "%s"),
"ticket": ("https://code.djangoproject.com/ticket/%s", "#%s"),
}
+if sphinx_version < (8, 1):
+ extlinks["cve"] = ("https://www.cve.org/CVERecord?id=CVE-%s", "CVE-%s")
+
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None