forked from pypa/packaging.python.org
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconf.py
More file actions
174 lines (141 loc) · 6.55 KB
/
conf.py
File metadata and controls
174 lines (141 loc) · 6.55 KB
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
# -- Project information ---------------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "Python Packaging User Guide"
copyright = "2013–2020, PyPA"
author = "Python Packaging Authority"
# -- General configuration -------------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
root_doc = "index"
extensions = [
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx_inline_tabs",
"sphinx_copybutton",
"sphinx_toolbox.collapse",
]
nitpicky = True
nitpick_ignore = [
("envvar", "PATH"),
("py:func", "find_packages"),
("py:func", "setup"),
("py:func", "importlib.metadata.entry_points"),
("py:class", "importlib.metadata.EntryPoint"),
("py:func", "setuptools.find_namespace_packages"),
("py:func", "setuptools.find_packages"),
("py:func", "setuptools.setup"),
]
default_role = "any"
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for internationalization --------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-internationalization
language = "en"
locale_dirs = ["../locales"]
gettext_auto_build = True
gettext_compact = "messages"
gettext_location = True
# -- Options for HTML output -----------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_title = "Python Packaging User Guide"
html_theme = "furo"
html_favicon = "assets/py.png"
html_last_updated_fmt = ""
# -- Options for HTML help output ------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-help-output
htmlhelp_basename = "pythonpackagingguide-authdoc"
# -- Options for LaTeX output ----------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output
latex_elements = {}
latex_documents = [
(
root_doc,
"pythonpackagingguide.tex",
"Python Packaging User Guide",
"Python Packaging Authority",
"manual",
),
]
# -- Options for manual page output ----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-manual-page-output
man_pages = [
(root_doc, "pythonpackagingguide", "Python Packaging User Guide", [author], 1)
]
# -- Options for Texinfo output --------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-texinfo-output
texinfo_documents = [
(
root_doc,
"pythonpackagingguide",
"Python Packaging User Guide",
author,
"pythonpackagingguide",
"One line description of project.",
"Miscellaneous",
),
]
# -- Options for the linkcheck builder -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
linkcheck_ignore = [
"http://localhost:\\d+",
"https://test.pypi.org/project/example-package-YOUR-USERNAME-HERE",
"https://pypi.org/manage/*",
"https://test.pypi.org/manage/*",
# Temporarily ignored. Ref:
# https://github.com/pypa/packaging.python.org/pull/1308#issuecomment-1775347690
"https://www.breezy-vcs.org/*",
]
linkcheck_retries = 5
# -- Options for extlinks ----------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#configuration
github_url = "https://github.com"
github_repo_org = "pypa"
github_repo_name = "packaging.python.org"
github_repo_slug = f"{github_repo_org}/{github_repo_name}"
github_repo_url = f"{github_url}/{github_repo_slug}"
github_repo_issues_url = f"{github_url}/{github_repo_slug}/issues"
github_sponsors_url = f"{github_url}/sponsors"
extlinks = {
"issue": (f"{github_repo_issues_url}/%s", "#%s"),
"pr": (f"{github_repo_url}/pull/%s", "PR #%s"),
"commit": (f"{github_repo_url}/commit/%s", "%s"),
"gh": (f"{github_url}/%s", "GitHub: %s"),
"user": (f"{github_sponsors_url}/%s", "@%s"),
}
# -- Options for intersphinx ----------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
intersphinx_mapping = {
"boltons": ("https://boltons.readthedocs.io/en/latest/", None),
"bottle": ("https://bottlepy.org/docs/dev/", None),
"build": ("https://pypa-build.readthedocs.io/en/stable/", None),
"cffi": ("https://cffi.readthedocs.io/en/latest/", None),
"conda": ("https://conda.io/en/latest/", None),
"devpi": ("https://devpi.net/docs/devpi/devpi/latest/+doc", None),
"dh-virtualenv": ("https://dh-virtualenv.readthedocs.io/en/latest/", None),
"distlib": ("https://distlib.readthedocs.io/en/latest/", None),
"flexx": ("https://flexx.readthedocs.io/en/latest/", None),
"flit": ("https://flit.pypa.io/en/stable/", None),
"nox": ("https://nox.thea.codes/en/latest/", None),
"openstack": ("https://docs.openstack.org/glance/latest/", None),
"packaging": ("https://packaging.pypa.io/en/latest/", None),
"pip": ("https://pip.pypa.io/en/latest/", None),
"pipenv": ("https://pipenv.pypa.io/en/latest/", None),
"piwheels": ("https://piwheels.readthedocs.io/en/latest/", None),
"pybind11": ("https://pybind11.readthedocs.io/en/stable/", None),
"pynsist": ("https://pynsist.readthedocs.io/en/latest/", None),
"pypa": ("https://www.pypa.io/en/latest/", None),
"python": ("https://docs.python.org/3", None),
"python-guide": ("https://docs.python-guide.org", None),
"setuptools": ("https://setuptools.pypa.io/en/latest/", None),
"spack": ("https://spack.readthedocs.io/en/latest/", None),
"sphinx": ("https://www.sphinx-doc.org/en/master", None),
"tox": ("https://tox.wiki/en/latest/", None),
"twine": ("https://twine.readthedocs.io/en/stable/", None),
"virtualenv": ("https://virtualenv.pypa.io/en/stable/", None),
}
# -- Options for todo extension --------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
todo_include_todos = True
# -- Options for sphinx-copybutton -----------------------------------------------------
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html
copybutton_prompt_text = r">>> |\.\.\. |\$ |> "
copybutton_prompt_is_regexp = True