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
|
# SPDX-License-Identifier: MIT
from importlib import metadata
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"myst_parser",
"notfound.extension",
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.napoleon",
"sphinx_copybutton",
]
myst_enable_extensions = ["deflist", "colon_fence"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# The suffix of source filenames.
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"
# General information about the project.
project = "argon2-cffi"
copyright = "2015, Hynek Schlawack"
# 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.
#
# The full version, including alpha/beta/rc tags.
if "dev" in (release := metadata.version("argon2-cffi")):
release = version = "UNRELEASED"
else:
# The short X.Y version.
version = release.rsplit(".", 1)[0]
# Move type hints into the description block, instead of the func definition.
autodoc_typehints = "description"
autodoc_typehints_description_target = "documented"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["_build"]
# nitpick_ignore = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
default_role = "any"
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
# -- Options for HTML output ----------------------------------------------
# html_theme = "furo"
# html_theme_options = {
# "top_of_page_buttons": [],
# "light_css_variables": {
# "font-stack": "Inter,sans-serif",
# "font-stack--monospace": "BerkeleyMono, MonoLisa, ui-monospace, "
# "SFMono-Regular, Menlo, Consolas, Liberation Mono, monospace",
# },
# }
html_static_path = ["_static"]
html_css_files = ["custom.css"]
# Output file base name for HTML help builder.
htmlhelp_basename = "argon2-cffidoc"
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
"index",
"argon2-cffi.tex",
"argon2-cffi Documentation",
"Hynek Schlawack",
"manual",
)
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(
"index",
"argon2-cffi",
"argon2-cffi Documentation",
["Hynek Schlawack"],
1,
)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
"index",
"argon2-cffi",
"argon2-cffi Documentation",
"Hynek Schlawack",
"argon2-cffi",
"Argon2 for Python",
"Miscellaneous",
)
]
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
|
