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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
from __future__ import annotations
import os
import sys
from pathlib import Path
import tomllib
# -- Path setup --------------------------------------------------------------
here = Path(__file__).parent.resolve()
sys.path.insert(0, str(here / ".." / "src"))
# -- Project information -----------------------------------------------------
with (here / ".." / "pyproject.toml").open("rb") as fp:
pyproject_toml_data = tomllib.load(fp)
project = pyproject_toml_data["project"]["name"]
copyright = "2020 Adam Johnson"
author = "Adam Johnson"
# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
# the built documents.
version = pyproject_toml_data["project"]["version"]
release = version
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_copybutton",
]
if os.environ.get("READTHEDOCS") == "True":
extensions.append("sphinx_build_compatibility.extension")
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
".venv",
"_build",
]
autodoc_typehints = "description"
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_logo = "_static/logo.svg"
html_theme = "furo"
html_theme_options = {
"dark_css_variables": {
"admonition-font-size": "100%",
"admonition-title-font-size": "100%",
},
"light_css_variables": {
"admonition-font-size": "100%",
"admonition-title-font-size": "100%",
},
}
# -- Options for LaTeX output ------------------------------------------
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
(
"index",
"django-htmx.tex",
"django-htmx Documentation",
"Adam Johnson",
"manual",
),
]
# -- Options for Intersphinx -------------------------------------------
intersphinx_mapping = {
"django": (
"/usr/share/doc/python-django-doc/html",
None
),
}
|
