fix iniparse

fix code passing ruff linter pre-commit ruff pre-commit ruff format
2024-11-29 22:54:39 +01:00
parent aa8a68aa80
commit 737f9bea38
27 changed files with 2375 additions and 2016 deletions
@@ -30,50 +30,50 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
 ]

 # 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'
+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 = 'TISBackup'
-copyright = '2020, Tranquil IT'
-author = 'Tranquil IT'
+project = "TISBackup"
+copyright = "2020, Tranquil IT"
+author = "Tranquil IT"

 # 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.
 #
 # The short X.Y version.
-version = '1.8'
+version = "1.8"
 # The full version, including alpha/beta/rc tags.
-release = '1.8.2'
+release = "1.8.2"

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
-locale_dirs = ['locale/']
+language = "en"
+locale_dirs = ["locale/"]
 gettext_compact = False

 # There are two options for replacing |today|: either, you set today to some
@@ -110,7 +110,7 @@ exclude_patterns = []
 # 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 = []
@@ -126,18 +126,19 @@ todo_include_todos = True

 try:
    import sphinx_rtd_theme
+
    html_theme = "sphinx_rtd_theme"
    html_favicon = "_static/favicon.ico"
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    html_context = {
-        'css_files': [
-            '_static/css/custom.css',  # overrides for wide tables in RTD theme
-            '_static/css/ribbon.css',
-        '_static/theme_overrides.css',  # override wide tables in RTD theme
+        "css_files": [
+            "_static/css/custom.css",  # overrides for wide tables in RTD theme
+            "_static/css/ribbon.css",
+            "_static/theme_overrides.css",  # override wide tables in RTD theme
        ],
    }
-except ImportError as e:
-    html_theme = 'alabaster'
+except ImportError as e:  # noqa : F841
+    html_theme = "alabaster"
    html_theme_path = []


@@ -178,7 +179,7 @@ except ImportError as e:
 # 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"]

 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -258,15 +259,13 @@ html_static_path = ['_static']
 # html_search_scorer = 'scorer.js'

 # Output file base name for HTML help builder.
-htmlhelp_basename = 'tisbackupdoc'
+htmlhelp_basename = "tisbackupdoc"

 # -- Linkcheck -------------------
 # make linkcheck
 # URL patterns to ignore

-linkcheck_ignore = [r'http.*://.*mydomain.lan.*',
-                    r'http.*://.*host_fqdn.*',
-                    r'http://user:pwd@host_fqdn:port']
+linkcheck_ignore = [r"http.*://.*mydomain.lan.*", r"http.*://.*host_fqdn.*", r"http://user:pwd@host_fqdn:port"]


 # -- Options for LaTeX output ---------------------------------------------
@@ -279,23 +278,20 @@ linkcheck_ignore = [r'http.*://.*mydomain.lan.*',
 # >     \setlength\paperwidth  {15.59cm}}

 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-     'papersize': 'lulupaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     'pointsize': '9pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     'preamble': r'\batchmode',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
-     'sphinxsetup': 'hmargin={1.5cm,1.5cm}, vmargin={3cm,3cm}, marginpar=1cm',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    "papersize": "lulupaper",
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    "pointsize": "9pt",
+    # Additional stuff for the LaTeX preamble.
+    #
+    "preamble": r"\batchmode",
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+    "sphinxsetup": "hmargin={1.5cm,1.5cm}, vmargin={3cm,3cm}, marginpar=1cm",
 }


@@ -303,7 +299,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'tisbackup.tex', 'TISBackup Documentation', 'Tranquil IT', 'manual'),
+    (master_doc, "tisbackup.tex", "TISBackup Documentation", "Tranquil IT", "manual"),
 ]

 # The name of an image file (relative to this directory) to place at the top of
@@ -343,10 +339,7 @@ latex_documents = [

 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'tisbackup', 'TISBackup Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "tisbackup", "TISBackup Documentation", [author], 1)]

 # If true, show URL addresses after external links.
 #
@@ -359,9 +352,15 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'tisbackup', 'TISBackup Documentation',
-     author, 'Tranquil IT', 'The objective of TISbackup is to benefit from file backups and centralized alert feedback on "reasonable" data volumes.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "tisbackup",
+        "TISBackup Documentation",
+        author,
+        "Tranquil IT",
+        'The objective of TISbackup is to benefit from file backups and centralized alert feedback on "reasonable" data volumes.',
+        "Miscellaneous",
+    ),
 ]

 # Documents to append as an appendix to all manuals.
@@ -382,7 +381,7 @@ texinfo_documents = [


 # 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 Epub output ----------------------------------------------

@@ -438,7 +437,7 @@ epub_copyright = copyright
 # epub_post_files = []

 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]

 # The depth of the table of contents in toc.ncx.
 #