Applying black formatting

- Fixing flake8 configuration to agree with black
- Adding black validation check to github actions
This commit is contained in:
Jacob Alexander
2021-10-01 11:00:22 -07:00
parent 5dade41aeb
commit 6e7fffd7de
51 changed files with 2536 additions and 1837 deletions

View File

@@ -1,6 +1,6 @@
'''
"""
Docs configuration
'''
"""
# -*- coding: utf-8 -*-
#
# capnp documentation build configuration file, created by
@@ -15,6 +15,7 @@ Docs configuration
# serve to show the default.
import string
# import sys, os
import capnp
@@ -31,27 +32,27 @@ import capnp
# 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.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx_multiversion',
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
"sphinx_multiversion",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'capnp'
copyright = u'2013-2019 (Jason Paryani), 2019-2020 (Jacob Alexander)'
project = u"capnp"
copyright = u"2013-2019 (Jason Paryani), 2019-2020 (Jacob Alexander)"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -77,7 +78,7 @@ release = vs
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ["_build"]
# The reST default role (used for this markup: `text`) to use for all documents.
# default_role = None
@@ -94,7 +95,7 @@ exclude_patterns = ['_build']
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@@ -104,7 +105,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
html_theme = "nature"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -144,7 +145,15 @@ html_theme = 'nature'
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
html_sidebars = {'**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html', 'versioning.html']}
html_sidebars = {
"**": [
"globaltoc.html",
"relations.html",
"sourcelink.html",
"searchbox.html",
"versioning.html",
]
}
# Additional templates that should be rendered to pages, maps page names to
# template names.
@@ -177,7 +186,7 @@ html_sidebars = {'**': ['globaltoc.html', 'relations.html', 'sourcelink.html', '
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'capnpdoc'
htmlhelp_basename = "capnpdoc"
# -- Options for LaTeX output --------------------------------------------------
@@ -190,14 +199,12 @@ htmlhelp_basename = 'capnpdoc'
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
latex_elements = {
}
latex_elements = {}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'capnp.tex', u'capnp Documentation',
u'Author', 'manual'),
("index", "capnp.tex", u"capnp Documentation", u"Author", "manual"),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -225,10 +232,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'capnp', u'capnp Documentation',
[u'Author'], 1)
]
man_pages = [("index", "capnp", u"capnp Documentation", [u"Author"], 1)]
# If true, show URL addresses after external links.
# man_show_urls = False
@@ -240,9 +244,15 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'capnp', u'capnp Documentation',
u'Author', 'capnp', 'One line description of project.',
'Miscellaneous'),
(
"index",
"capnp",
u"capnp Documentation",
u"Author",
"capnp",
"One line description of project.",
"Miscellaneous",
),
]
# Documents to append as an appendix to all manuals.
@@ -258,10 +268,10 @@ texinfo_documents = [
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'capnp'
epub_author = u'Author'
epub_publisher = u'Author'
epub_copyright = u'2013, Author'
epub_title = u"capnp"
epub_author = u"Author"
epub_publisher = u"Author"
epub_copyright = u"2013, Author"
# The language of the text. It defaults to the language option
# or en if the language is not set.
@@ -297,6 +307,6 @@ epub_copyright = u'2013, Author'
# Allow duplicate toc entries.
# epub_tocdup = True
intersphinx_mapping = {'http://docs.python.org/': None}
intersphinx_mapping = {"http://docs.python.org/": None}
smv_branch_whitelist = r'^master$'
smv_branch_whitelist = r"^master$"