Format docs/conf.py

Author: amorison

docs/conf.py

@@ -10,66 +10,67 @@
 # 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 sys
 import os
+import sys
 from dataclasses import fields
 from pathlib import Path
 from textwrap import dedent
+
 from pkg_resources import get_distribution
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 # do not try to create/read config files
-os.environ['STAGPY_ISOLATED'] = 'True'
+os.environ["STAGPY_ISOLATED"] = "True"
 
 import stagpy
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '4.0'
+needs_sphinx = "4.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.mathjax',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
+    "sphinx.ext.mathjax",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
 ]
 
-root_doc = 'index'
+root_doc = "index"
 
-autodoc_member_order = 'bysource'
-autoclass_content = 'class'
+autodoc_member_order = "bysource"
+autoclass_content = "class"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # -- Project information -----------------------------------------------------
-project = 'StagPy'
-copyright = '2015 - 2023, Adrien Morison, Martina Ulvrova, Stéphane Labrosse'
-author = 'Adrien Morison, Martina Ulvrova, Stéphane Labrosse'
+project = "StagPy"
+copyright = "2015 - 2023, Adrien Morison, Martina Ulvrova, Stéphane Labrosse"
+author = "Adrien Morison, Martina Ulvrova, Stéphane Labrosse"
 
 # The full version, including alpha/beta/rc tags.
 release = get_distribution("stagpy").version
 # The short X.Y version.
-version = '.'.join(release.split('.')[:2])
+version = ".".join(release.split(".")[:2])
 
 # 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 name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'StagPydoc'
+htmlhelp_basename = "StagPydoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -78,19 +79,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (root_doc, 'StagPy.tex', 'StagPy Documentation',
-     r'Adrien Morison \and Martina Ulvrova \and Stéphane Labrosse', 'manual'),
+    (
+        root_doc,
+        "StagPy.tex",
+        "StagPy Documentation",
+        r"Adrien Morison \and Martina Ulvrova \and Stéphane Labrosse",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (root_doc, 'stagpy', 'StagPy Documentation',
-     [author], 1)
-]
+man_pages = [(root_doc, "stagpy", "StagPy Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -99,18 +102,25 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (root_doc, 'StagPy', 'StagPy Documentation',
-     author, 'StagPy', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        root_doc,
+        "StagPy",
+        "StagPy Documentation",
+        author,
+        "StagPy",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
 # -- Autogenerated configuration options list -----------------------------
 
-dfile = Path('.') / 'sources' / 'config_opts.rst'
-with dfile.open('w') as fid:
-    fid.write(dedent(
-        """\
+dfile = Path(".") / "sources" / "config_opts.rst"
+with dfile.open("w") as fid:
+    fid.write(
+        dedent(
+            """\
         ..
            This doc is automatically generated in conf.py.
            Editing it will have no effect.
@@ -120,28 +130,33 @@
         =============================
 
         These tables list configuration options.
-        """))
+        """
+        )
+    )
     for sec_fld in fields(stagpy.conf):
         sec_name = sec_fld.name
-        fid.write(dedent(
-            """
+        fid.write(
+            dedent(
+                """
             .. list-table:: {}
                :header-rows: 1
 
                * - Name
                  - Description
                  - CLI, config file?
-            """.format(sec_name)))
+            """.format(sec_name)
+            )
+        )
         section = getattr(stagpy.conf, sec_name)
         for fld in fields(section):
             opt = fld.name
             entry = section.meta_(opt).entry
             if entry.in_cli and entry.in_file:
-                c_f = 'both'
+                c_f = "both"
             elif entry.in_cli:
-                c_f = 'CLI'
+                c_f = "CLI"
             else:
-                c_f = 'config file'
-            fid.write('   * - {}\n'.format(opt))
-            fid.write('     - {}\n'.format(entry.doc))
-            fid.write('     - {}\n'.format(c_f))
+                c_f = "config file"
+            fid.write("   * - {}\n".format(opt))
+            fid.write("     - {}\n".format(entry.doc))
+            fid.write("     - {}\n".format(c_f))

tox.ini

@@ -34,15 +34,15 @@ skip_install = true
 deps =
     ruff==0.3.4
 commands =
-    ruff check --select I --fix stagpy tests
-    ruff format stagpy tests
+    ruff check --select I --fix .
+    ruff format .
 
 [testenv:fmt-check]
 skip_install = true
 deps = {[testenv:fmt]deps}
 commands =
-    ruff check --select I stagpy tests
-    ruff format --check stagpy tests
+    ruff check --select I .
+    ruff format --check .
 
 [gh]
 python =