blacken sphinx config

docs/conf.py

@@ -15,81 +15,87 @@
 # 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.
-#sys.path.insert(0, os.path.abspath('..'))
+# sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # 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.autosummary',
-              'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode',
-              'sphinx.ext.graphviz', 'sphinx.ext.inheritance_diagram',
-              'sphinx_rtd_theme',
-             ]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx_rtd_theme",
+]
 
 # 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'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'MoinMoin'
-copyright = '2011-2022, The MoinMoin developers'
+project = "MoinMoin"
+copyright = "2011-2022, The MoinMoin developers"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 from pkg_resources import get_distribution
+
 # The full version, including alpha/beta/rc tags.
-release = get_distribution('moin').version
+release = get_distribution("moin").version
 # The short X.Y version.
-version = '.'.join(release.split('.')[:2])
+version = ".".join(release.split(".")[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # 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
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# 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 = ['moin.', ]
+modindex_common_prefix = ["moin."]
 
 
 # -- Options for HTML output ---------------------------------------------------
@@ -98,7 +104,7 @@
 # a list of builtin themes.
 # html_theme = 'classic'
 # html_theme = 'alabaster'
-html_theme = 'sphinx_rtd_theme'  # winner, mobile friendly
+html_theme = "sphinx_rtd_theme"  # winner, mobile friendly
 # html_theme = 'sphinxdoc'
 # html_theme = 'scrolls'
 # html_theme = 'agogo'
@@ -111,128 +117,125 @@
 # The style sheet to use for HTML pages. A file of that name must exist either
 # in Sphinx’ static/ path, or in one of the custom paths given in
 # html_static_path. Default is the stylesheet given by the selected theme.
-html_style = 'custom.css'
+html_style = "custom.css"
 
 # 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
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = '_static/Logo_MoinMoin.png'
+html_logo = "_static/Logo_MoinMoin.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/favicon.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_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'moindoc'
+htmlhelp_basename = "moindoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-latex_paper_size = 'a4'
+latex_paper_size = "a4"
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'MoinMoin.tex', 'MoinMoin Documentation',
-   'The MoinMoin developers', 'manual'),
-]
+latex_documents = [("index", "MoinMoin.tex", "MoinMoin Documentation", "The MoinMoin developers", "manual")]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('man/moin', 'moin', 'MoinMoin Commandline Interface', ['The MoinMoin developers'], 1),
-    ('index', 'moinmoin', 'MoinMoin Documentation', ['The MoinMoin developers'], 1),
+    ("man/moin", "moin", "MoinMoin Commandline Interface", ["The MoinMoin developers"], 1),
+    ("index", "moinmoin", "MoinMoin Documentation", ["The MoinMoin developers"], 1),
 ]
 
 
@@ -242,8 +245,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'MoinMoin', 'MoinMoin Documentation', 'The MoinMoin developers',
-   'MoinMoin', 'One line description of project.', 'Miscellaneous'),
+    (
+        "index",
+        "MoinMoin",
+        "MoinMoin Documentation",
+        "The MoinMoin developers",
+        "MoinMoin",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -255,15 +265,12 @@
 # .. inheritance-diagram::
 #    moin.items.MoinWiki
 
-inheritance_graph_attrs = dict(rankdir="LR", size='"12.0, 16.0"',
-                               fontsize=20, ratio='compress')
+inheritance_graph_attrs = dict(rankdir="LR", size='"12.0, 16.0"', fontsize=20, ratio="compress")
 
-inheritance_node_attrs = dict(shape='box', fontsize=20, height=0.75,
-                              color='yellow', style='filled')
+inheritance_node_attrs = dict(shape="box", fontsize=20, height=0.75, color="yellow", style="filled")
 
 autosummary_generate = True
 
 # -- Options for Linkcheck -----------------------------------------------------
 
-linkcheck_ignore = ['http://127.0.0.1.*', 'http://localhost.*', 'http:Home.*', 'http:#.*', 'ItemName.*']
-
+linkcheck_ignore = ["http://127.0.0.1.*", "http://localhost.*", "http:Home.*", "http:#.*", "ItemName.*"]