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
|
# 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 os
import sys
import aiohttp
import datetime
sys.path.insert(0, os.path.abspath('..'))
# -- Project information -----------------------------------------------------
project = 'twitchAPI'
copyright = f'{datetime.date.today().year}, Lena "Teekeks" During'
author = 'Lena "Teekeks" During'
# The full version, including alpha/beta/rc tags
release = None
with open('../twitchAPI/__init__.py') as f:
for line in f.readlines():
if line.startswith('__version__'):
release = 'v' + line.split('= \'')[-1][:-2].strip()
if release is None:
release = 'dev'
language = 'en'
master_doc = 'index'
add_module_names = True
show_warning_types = True
# -- 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_autodoc_typehints',
'sphinx.ext.intersphinx',
'sphinx.ext.autosummary',
'enum_tools.autoenum',
'recommonmark',
'sphinx_paramlinks',
'sphinx_favicon',
'sphinx_copybutton',
'sphinx_design'
]
aiohttp.client.ClientTimeout.__module__ = 'aiohttp'
aiohttp.ClientTimeout.__module__ = 'aiohttp'
autodoc_member_order = 'bysource'
autodoc_class_signature = 'separated'
# 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']
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'aio': ('https://docs.aiohttp.org/en/stable/', None)
}
rst_epilog = """
.. |default| raw:: html
<div class="default-value-section"> <span class="default-value-label">Default:</span>
.. |br| raw:: html
<br>
"""
def setup(app):
app.add_css_file('css/custom.css')
html_theme = 'pydata_sphinx_theme'
# Define the json_url for our version switcher.
json_url = "/en/latest/_static/switcher.json"
# Define the version we use for matching in the version switcher.
version_match = os.environ.get("READTHEDOCS_VERSION")
# If READTHEDOCS_VERSION doesn't exist, we're not on RTD
# If it is an integer, we're in a PR build and the version isn't correct.
if not version_match or version_match.isdigit():
# For local development, infer the version to match from the package.
# release = release
if "-a" in release or "-b" in release or "rc" in release:
version_match = "develop"
# We want to keep the relative reference if we are in dev mode
# but we want the whole url if we are effectively in a released version
json_url = "/en/latest/_static/switcher.json"
else:
version_match = release
html_theme_options = {
"switcher": {
"json_url": json_url,
"version_match": version_match,
},
"header_links_before_dropdown": 4,
"navbar_center": ["version-switcher", "navbar-nav"],
"pygments_dark_style": "monokai",
"navbar_align": "left",
"logo": {
"text": "twitchAPI",
"image_light": "logo.png",
"image_dark": "logo.png"
},
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/Teekeks/pyTwitchAPI",
"icon": "fa-brands fa-github",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/twitchAPI",
"icon": "fa-custom fa-pypi",
},
{
"name": "Discord Support Server",
"url": "https://discord.gg/tu2Dmc7gpd",
"icon": "fa-brands fa-discord",
}
],
"secondary_sidebar_items": {
"**": ["page-toc"]
}
}
# remove left sidebar
html_sidebars = {
"**": []
}
favicons = [
"logo-32x32.png",
"logo-16x16.png",
{"rel": "shortcut icon", "sizes": "any", "href": "logo.ico"},
]
# 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']
html_js_files = ['icons/pypi-icon.js']
|
