drgn/docs/conf.py
Omar Sandoval 2c38ea5219 docs: update required Sphinx version to 5.1.1
Just picking up the newest version. Also fix the following warning:

  WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.

Signed-off-by: Omar Sandoval <osandov@osandov.com>
2022-07-27 10:04:20 -07:00

50 lines
998 B
Python

import os.path
import sys
sys.path.append(os.path.abspath(".."))
sys.path.append(os.path.abspath("exts"))
master_doc = "index"
extensions = [
"drgndoc.ext",
"setuptools_config",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
]
drgndoc_paths = ["../drgn", "../_drgn.pyi"]
drgndoc_substitutions = [
(r"^_drgn\b", "drgn"),
]
extlinks = {
"linux": (
"https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/%s",
"%s",
),
}
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
}
manpages_url = "http://man7.org/linux/man-pages/man{section}/{page}.{section}.html"
html_static_path = ["_static"]
html_theme = "alabaster"
html_theme_options = {
"description": "Debugger-as-a-library",
"logo": "logo.png",
"logo_name": True,
"logo_text_align": "center",
"github_user": "osandov",
"github_repo": "drgn",
"github_button": True,
"github_type": "star",
}
html_favicon = "favicon.ico"