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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# Copyright 2021-2024 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
#
# 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
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import datetime
import os
import pathlib
import sys
try:
from importlib_metadata import distribution
except ImportError:
from importlib.metadata import distribution
try:
DOCS_BASEPATH = pathlib.Path(__file__).resolve().parent
except NameError:
# sphinx-intl and six execute some code which will raise this NameError
# assume we're in the doc/ directory
DOCS_BASEPATH = pathlib.Path(".").resolve().parent
REPO_ROOT = DOCS_BASEPATH.parent
addtl_paths = (
os.path.join(os.pardir, "src"), # pytest-shell-utilities itself (for autodoc)
"_ext", # custom Sphinx extensions
)
for addtl_path in addtl_paths:
sys.path.insert(0, os.path.abspath(os.path.join(DOCS_BASEPATH, addtl_path)))
dist = distribution("pytest-shell-utilities")
# -- Project information -----------------------------------------------------
this_year = datetime.datetime.today().year
if this_year == 2021:
copyright_year = 2021
else:
copyright_year = f"2021 - {this_year}"
project = dist.metadata["Summary"]
author = dist.metadata["Author"]
copyright = f"{copyright_year}, {author}" # pylint: disable=redefined-builtin
# The full version, including alpha/beta/rc tags
release = dist.version
# Variables to pass into the docs from sitevars.rst for rst substitution
with open("sitevars.rst", encoding="utf-8") as site_vars_file:
site_vars = site_vars_file.read().splitlines()
rst_prolog = """
{}
""".format(
"\n".join(site_vars[:])
)
# -- 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.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx_copybutton",
"sphinxcontrib.spelling",
"sphinxcontrib.towncrier",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
".vscode",
".venv",
".git",
".gitlab-ci",
".gitignore",
"sitevars.rst",
]
autosummary_generate = True
modindex_common_prefix = ["saf."]
master_doc = "contents"
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "furo"
html_title = project
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "_static/img/SaltProject_altlogo_teal.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large. Favicons can be up to at least 228x228. PNG
# format is supported as well, not just .ico'
html_favicon = "_static/img/SaltProject_Logomark_teal.png"
# Sphinx Napoleon Config
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = True
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_references = True
napoleon_use_ivar = True
napoleon_use_param = True
napoleon_use_keyword = True
napoleon_use_rtype = True
napoleon_attr_annotations = True
napoleon_preprocess_types = True
# ----- Intersphinx Config ---------------------------------------------------------------------------------------->
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"pytest": ("https://docs.pytest.org/en/stable", None),
}
# <---- Intersphinx Config -----------------------------------------------------------------------------------------
# ----- Autodoc Config ---------------------------------------------------------------------------------------------->
autodoc_default_options = {"member-order": "bysource"}
autodoc_mock_imports = []
# <---- Autodoc Config -----------------------------------------------------------------------------------------------
# ----- Towncrier Draft Release ------------------------------------------------------------------------------------->
# Options: draft/sphinx-version/sphinx-release
towncrier_draft_autoversion_mode = "draft"
towncrier_draft_include_empty = True
towncrier_draft_working_directory = REPO_ROOT
# Not yet supported:
# towncrier_draft_config_path = 'pyproject.toml' # relative to cwd
# <---- Towncrier Draft Release --------------------------------------------------------------------------------------
def setup(app):
app.add_crossref_type(
directivename="fixture",
rolename="fixture",
indextemplate="pair: %s; fixture",
)
# Allow linking to pytest's confvals.
app.add_object_type(
"confval",
"pytest-confval",
objname="configuration value",
indextemplate="pair: %s; configuration value",
)
|
