Skip to content

Commit 0893af1

Browse files
Prepare to pass pre-commit
1 parent d836ac4 commit 0893af1

File tree

3 files changed

+60
-52
lines changed

3 files changed

+60
-52
lines changed

.github/workflows/images.yml

-1
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,3 @@ jobs:
4848
git add *.png index.html
4949
git remote add origin https://${GITHUB_ACTOR}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
5050
if git commit -m"update images"; then git push -f origin HEAD:folder-images; fi
51-

CODE_OF_CONDUCT.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Examples of unacceptable behavior by participants include:
4343

4444
The goal of the standards and moderation guidelines outlined here is to build
4545
and maintain a respectful community. We ask that you don’t just aim to be
46-
"technically unimpeachable", but rather try to be your best self.
46+
"technically unimpeachable", but rather try to be your best self.
4747

4848
We value many things beyond technical expertise, including collaboration and
4949
supporting others within our community. Providing a positive experience for
@@ -74,9 +74,9 @@ You may report in the following ways:
7474
In any situation, you may send an email to <support@adafruit.com>.
7575

7676
On the Adafruit Discord, you may send an open message from any channel
77-
to all Community Moderators by tagging @community moderators. You may
78-
also send an open message from any channel, or a direct message to
79-
@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442,
77+
to all Community Moderators by tagging @community moderators. You may
78+
also send an open message from any channel, or a direct message to
79+
@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442,
8080
@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
8181

8282
Email and direct message reports will be kept confidential.

docs/conf.py

+56-47
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
import os
44
import sys
5-
sys.path.insert(0, os.path.abspath('..'))
5+
6+
sys.path.insert(0, os.path.abspath(".."))
67

78
# -- General configuration ------------------------------------------------
89

910
# Add any Sphinx extension module names here, as strings. They can be
1011
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
1112
# ones.
1213
extensions = [
13-
'sphinx.ext.autodoc',
14-
'sphinx.ext.intersphinx',
15-
'sphinx.ext.napoleon',
16-
'sphinx.ext.todo',
14+
"sphinx.ext.autodoc",
15+
"sphinx.ext.intersphinx",
16+
"sphinx.ext.napoleon",
17+
"sphinx.ext.todo",
1718
]
1819

1920
# TODO: Please Read!
@@ -23,29 +24,29 @@
2324
# autodoc_mock_imports = ["digitalio", "busio"]
2425

2526

26-
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None)}
27+
intersphinx_mapping = {"python": ("https://docs.python.org/3.4", None)}
2728

2829
# Add any paths that contain templates here, relative to this directory.
29-
templates_path = ['_templates']
30+
templates_path = ["_templates"]
3031

31-
source_suffix = '.rst'
32+
source_suffix = ".rst"
3233

3334
# The master toctree document.
34-
master_doc = 'index'
35+
master_doc = "index"
3536

3637
# General information about the project.
37-
project = u'Adafruit CircuitPython Bundle'
38-
copyright = u'2019 Adafruit'
39-
author = u'Adabot'
38+
project = u"Adafruit CircuitPython Bundle"
39+
copyright = u"2019 Adafruit"
40+
author = u"Adabot"
4041

4142
# The version info for the project you're documenting, acts as replacement for
4243
# |version| and |release|, also used in various other places throughout the
4344
# built documents.
4445
#
4546
# The short X.Y version.
46-
version = u'1.0'
47+
version = u"1.0"
4748
# The full version, including alpha/beta/rc tags.
48-
release = u'1.0'
49+
release = u"1.0"
4950

5051
# The language for content autogenerated by Sphinx. Refer to documentation
5152
# for a list of supported languages.
@@ -57,7 +58,7 @@
5758
# List of patterns, relative to source directory, that match files and
5859
# directories to ignore when looking for source files.
5960
# This patterns also effect to html_static_path and html_extra_path
60-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
61+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
6162

6263
# The reST default role (used for this markup: `text`) to use for all
6364
# documents.
@@ -69,7 +70,7 @@
6970
add_function_parentheses = True
7071

7172
# The name of the Pygments (syntax highlighting) style to use.
72-
pygments_style = 'sphinx'
73+
pygments_style = "sphinx"
7374

7475
# If true, `todo` and `todoList` produce output, else they produce nothing.
7576
todo_include_todos = False
@@ -84,68 +85,70 @@
8485
# The theme to use for HTML and HTML Help pages. See the documentation for
8586
# a list of builtin themes.
8687
#
87-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
88+
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
8889

8990
if not on_rtd: # only import and set the theme if we're building docs locally
9091
try:
9192
import sphinx_rtd_theme
92-
html_theme = 'sphinx_rtd_theme'
93-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
93+
94+
html_theme = "sphinx_rtd_theme"
95+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
9496
except:
95-
html_theme = 'default'
96-
html_theme_path = ['.']
97+
html_theme = "default"
98+
html_theme_path = ["."]
9799
else:
98-
html_theme_path = ['.']
100+
html_theme_path = ["."]
99101

100102
# Add any paths that contain custom static files (such as style sheets) here,
101103
# relative to this directory. They are copied after the builtin static files,
102104
# so a file named "default.css" will overwrite the builtin "default.css".
103-
html_static_path = ['_static']
105+
html_static_path = ["_static"]
104106

105107
# The name of an image file (relative to this directory) to use as a favicon of
106108
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
107109
# pixels large.
108110
#
109-
html_favicon = '_static/favicon.ico'
111+
html_favicon = "_static/favicon.ico"
110112

111113
# Output file base name for HTML help builder.
112-
htmlhelp_basename = 'AdafruitBundleLibrarydoc'
114+
htmlhelp_basename = "AdafruitBundleLibrarydoc"
113115

114116
# -- Options for LaTeX output ---------------------------------------------
115117

116118
latex_elements = {
117-
# The paper size ('letterpaper' or 'a4paper').
118-
#
119-
# 'papersize': 'letterpaper',
120-
121-
# The font size ('10pt', '11pt' or '12pt').
122-
#
123-
# 'pointsize': '10pt',
124-
125-
# Additional stuff for the LaTeX preamble.
126-
#
127-
# 'preamble': '',
128-
129-
# Latex figure (float) alignment
130-
#
131-
# 'figure_align': 'htbp',
119+
# The paper size ('letterpaper' or 'a4paper').
120+
#
121+
# 'papersize': 'letterpaper',
122+
# The font size ('10pt', '11pt' or '12pt').
123+
#
124+
# 'pointsize': '10pt',
125+
# Additional stuff for the LaTeX preamble.
126+
#
127+
# 'preamble': '',
128+
# Latex figure (float) alignment
129+
#
130+
# 'figure_align': 'htbp',
132131
}
133132

134133
# Grouping the document tree into LaTeX files. List of tuples
135134
# (source start file, target name, title,
136135
# author, documentclass [howto, manual, or own class]).
137136
latex_documents = [
138-
(master_doc, 'AdafruitBundleLibrary.tex', u'AdafruitBundle Documentation',
139-
author, 'manual'),
137+
(
138+
master_doc,
139+
"AdafruitBundleLibrary.tex",
140+
u"AdafruitBundle Documentation",
141+
author,
142+
"manual",
143+
),
140144
]
141145

142146
# -- Options for manual page output ---------------------------------------
143147

144148
# One entry per manual page. List of tuples
145149
# (source start file, name, description, authors, manual section).
146150
man_pages = [
147-
(master_doc, 'AdafruitBundlelibrary', u'Adafruit Bundle Documentation',
148-
[author], 1)
151+
(master_doc, "AdafruitBundlelibrary", u"Adafruit Bundle Documentation", [author], 1)
149152
]
150153

151154
# -- Options for Texinfo output -------------------------------------------
@@ -154,7 +157,13 @@
154157
# (source start file, target name, title, author,
155158
# dir menu entry, description, category)
156159
texinfo_documents = [
157-
(master_doc, 'AdafruitBundleLibrary', u'Adafruit Bundle Documentation',
158-
author, 'AdafruitBundleLibrary', 'One line description of project.',
159-
'Miscellaneous'),
160+
(
161+
master_doc,
162+
"AdafruitBundleLibrary",
163+
u"Adafruit Bundle Documentation",
164+
author,
165+
"AdafruitBundleLibrary",
166+
"One line description of project.",
167+
"Miscellaneous",
168+
),
160169
]

0 commit comments

Comments
 (0)