[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

test_docs/Makefile

@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

test_docs/requirements.txt

@@ -1,2 +1,2 @@
 sphinx>=4.0
-pandoc
+pandoc

test_docs/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
 #
@@ -12,27 +11,27 @@
 # 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 inspect
 import os
 import sys
-import inspect
 
-sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
+sys.path.insert(0, os.path.abspath(os.path.join("..", "..")))
 
 from src import sandbox
 
 # -- Project information -----------------------------------------------------
 
 project = sandbox.__name__
-copyright = '2019, JB'
-author = 'JB'
+copyright = "2019, JB"
+author = "JB"
 
 # The short X.Y version
 version = sandbox.__version__
 # The full version, including alpha/beta/rc tags
 release = sandbox.__version__
 
 # export the documentation
-with open('intro.md', 'w') as fp:
+with open("intro.md", "w") as fp:
     # fp.write(sandbox.__doc__.replace(os.linesep + ' ', ''))
     fp.write(sandbox.__doc__)
 
@@ -41,35 +40,35 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 
-needs_sphinx = '1.8'
+needs_sphinx = "1.8"
 
 # 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.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
     # 'sphinx.ext.viewcode',
-    'sphinx.ext.linkcode',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.autosummary',
-    'recommonmark',
+    "sphinx.ext.linkcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+    "recommonmark",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -81,7 +80,7 @@
 # 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 = ['modules.rst']
+exclude_patterns = ["modules.rst"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -92,7 +91,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 # http://www.sphinx-doc.org/en/master/usage/theming.html#builtin-themes
-html_theme = 'classic'
+html_theme = "classic"
 
 # 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
@@ -119,7 +118,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SandboxDoc'
+htmlhelp_basename = "SandboxDoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -128,15 +127,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -146,17 +142,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'SampleProject.tex', 'Sample Project Documentation', 'JB', 'manual'),
+    (master_doc, "SampleProject.tex", "Sample Project Documentation", "JB", "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'sampleproject', 'Sample Project Documentation', [author], 1)
-]
+man_pages = [(master_doc, "sampleproject", "Sample Project Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -165,8 +159,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'SampleProject', 'Sample Project Documentation', author, 'SampleProject',
-     'One line description of project.', 'Miscellaneous'),
+    (
+        master_doc,
+        "SampleProject",
+        "Sample Project Documentation",
+        author,
+        "SampleProject",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -185,15 +186,15 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------
 
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}
 
 # -- Options for todo extension ----------------------------------------------
 
@@ -202,8 +203,8 @@
 
 # Options for the linkcode extension
 # ----------------------------------
-github_user = 'Borda'
-github_repo = 'py_sample-project'
+github_user = "Borda"
+github_repo = "py_sample-project"
 
 
 # Resolve function
@@ -212,40 +213,42 @@ def linkcode_resolve(domain, info):
     def find_source():
         # try to find the file and line number, based on code from numpy:
         # https://github.com/numpy/numpy/blob/master/doc/source/conf.py#L286
-        obj = sys.modules[info['module']]
-        for part in info['fullname'].split('.'):
+        obj = sys.modules[info["module"]]
+        for part in info["fullname"].split("."):
             obj = getattr(obj, part)
         fname = inspect.getsourcefile(obj)
         # https://github.com/rtfd/readthedocs.org/issues/5735
-        if any([s in fname for s in ('readthedocs', 'rtfd', 'checkouts')]):
-            path_top = os.path.abspath(os.path.join('..', '..', '..'))
+        if any([s in fname for s in ("readthedocs", "rtfd", "checkouts")]):
+            path_top = os.path.abspath(os.path.join("..", "..", ".."))
             fname = os.path.relpath(fname, start=path_top)
         else:
             # Local build, imitate master
-            fname = 'master/' + os.path.relpath(fname, start=os.path.abspath('..'))
+            fname = "master/" + os.path.relpath(fname, start=os.path.abspath(".."))
         source, lineno = inspect.getsourcelines(obj)
         return fname, lineno, lineno + len(source) - 1
 
-    if domain != 'py' or not info['module']:
+    if domain != "py" or not info["module"]:
         return None
     try:
-        filename = '%s#L%d-L%d' % find_source()
+        filename = "%s#L%d-L%d" % find_source()
     except Exception:
-        filename = info['module'].replace('.', '/') + '.py'
+        filename = info["module"].replace(".", "/") + ".py"
     # import subprocess
     # tag = subprocess.Popen(['git', 'rev-parse', 'HEAD'], stdout=subprocess.PIPE,
     #                        universal_newlines=True).communicate()[0][:-1]
-    branch = filename.split('/')[0]
+    branch = filename.split("/")[0]
     # do mapping from latest tags to master
-    branch = {'latest': 'master', 'stable': 'master'}.get(branch, branch)
-    filename = '/'.join([branch] + filename.split('/')[1:])
-    return "https://github.com/%s/%s/blob/%s" \
-           % (github_user, github_repo, filename)
+    branch = {"latest": "master", "stable": "master"}.get(branch, branch)
+    filename = "/".join([branch] + filename.split("/")[1:])
+    return "https://github.com/%s/%s/blob/%s" % (github_user, github_repo, filename)
 
 
-autodoc_member_order = 'groupwise'
-autoclass_content = 'both'
+autodoc_member_order = "groupwise"
+autoclass_content = "both"
 autodoc_default_flags = [
-    'members', 'undoc-members', 'show-inheritance', 'private-members',
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "private-members",
     # 'special-members', 'inherited-members'
 ]

test_docs/source/index.rst

@@ -17,4 +17,4 @@ Indices and tables
 * :ref:`search`
 
 
-.. include:: intro.md
+.. include:: intro.md