-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathconf.py
More file actions
146 lines (125 loc) · 3.62 KB
/
Copy pathconf.py
File metadata and controls
146 lines (125 loc) · 3.62 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
#!/usr/bin/env python3
# This file is managed by 'repo_helper'. Don't edit it directly.
# stdlib
import os
import re
import sys
sys.path.append(os.path.abspath('.'))
sys.path.append(os.path.abspath(".."))
# 3rd party
import domdf_python_tools
# this package
from __pkginfo__ import __version__
domdf_python_tools.__docs = True
github_username = "domdfcoding"
github_repository = "domdf_python_tools"
github_url = f"https://github.com/{github_username}/{github_repository}"
rst_prolog = f""".. |pkgname| replace:: domdf_python_tools
.. |pkgname2| replace:: ``domdf_python_tools``
.. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__
"""
author = "Dominic Davis-Foster"
project = "domdf_python_tools"
slug = re.sub(r'\W+', '-', project.lower())
release = version = __version__
copyright = "2019-2021 Dominic Davis-Foster" # pylint: disable=redefined-builtin
language = "en"
package_root = "domdf_python_tools"
extensions = [
"sphinx_toolbox",
"sphinx_toolbox.more_autodoc",
"sphinx_toolbox.more_autosummary",
"sphinx_toolbox.tweaks.param_dash",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinxcontrib.httpdomain",
"sphinxcontrib.extras_require",
"sphinx.ext.todo",
"sphinxemoji.sphinxemoji",
"notfound.extension",
"sphinx_copybutton",
"sphinxcontrib.default_values",
"sphinxcontrib.toctree_plus",
"seed_intersphinx_mapping",
"sphinx_autofixture",
"sphinx_highlights",
]
sphinxemoji_style = "twemoji"
todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
gitstamp_fmt = "%d %b %Y"
templates_path = ["_templates"]
html_static_path = ["_static"]
source_suffix = ".rst"
master_doc = "index"
suppress_warnings = ["image.nonlocal_uri"]
pygments_style = "default"
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"sphinx": ("https://www.sphinx-doc.org/en/stable/", None),
"pandas": ("https://pandas.pydata.org/docs/", None),
"consolekit": ("https://consolekit.readthedocs.io/en/latest/", None),
"pytest": ("https://docs.pytest.org/en/stable", None),
"pytest-regressions": ("https://pytest-regressions.readthedocs.io/en/latest/", None),
}
html_theme = "domdf_sphinx_theme"
html_theme_options = {"logo_only": False}
html_theme_path = ["../.."]
html_show_sourcelink = True # True will show link to source
html_context = {
"display_github": True,
"github_user": "domdfcoding",
"github_repo": "domdf_python_tools",
"github_version": "master",
"conf_py_path": "/doc-source/",
}
htmlhelp_basename = slug
latex_documents = [("index", f'{slug}.tex', project, author, "manual")]
man_pages = [("index", slug, project, [author], 1)]
texinfo_documents = [("index", slug, project, author, slug, project, "Miscellaneous")]
toctree_plus_types = {
"class",
"function",
"method",
"data",
"enum",
"flag",
"confval",
"directive",
"role",
"confval",
"protocol",
"typeddict",
"namedtuple",
"exception",
}
add_module_names = False
hide_none_rtype = True
all_typevars = True
overloads_location = "bottom"
autodoc_exclude_members = [ # Exclude "standard" methods.
"__dict__",
"__class__",
"__dir__",
"__weakref__",
"__module__",
"__annotations__",
"__orig_bases__",
"__parameters__",
"__subclasshook__",
"__init_subclass__",
"__attrs_attrs__",
"__init__",
"__new__",
"__getnewargs__",
"__abstractmethods__",
"__hash__",
]
autodoc_default_options = {
"members": None, # Include all members (methods).
"special-members": None,
"autosummary": None,
"show-inheritance": None,
"exclude-members": ','.join(autodoc_exclude_members),
}
manpages_url = "https://manpages.debian.org/{path}"
toctree_plus_types.add("fixture")