drgn/docs/conf.py
Omar Sandoval e5021952c8 docs: disable sphinx.ext.viewcode
viewcode works by importing modules. This doesn't actually work on Read
the Docs because we don't build and install the C extension. It looks
like there are workarounds (viewcode-find-source), but let's disable it
for now.

Signed-off-by: Omar Sandoval <osandov@osandov.com>
2021-11-03 15:58:11 -07:00

50 lines
996 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",
"",
),
}
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"