Merge pull request #86 from mmschlk/70-fix-imports

update imports and ruff; fixes #70

.gitignore

@@ -1,3 +1,5 @@
+.vscode/**
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -21,4 +21,4 @@ repos:
         name: ruff
         language: python
         types: [python]
-        entry: ruff --no-cache --fix
+        entry: ruff check --no-cache --fix

docs/source/conf.py

@@ -3,22 +3,24 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-from sphinx.builders.html import StandaloneHTMLBuilder
 import os
 import sys
+
+from sphinx.builders.html import StandaloneHTMLBuilder
+
 sys.path.insert(0, os.path.abspath("../.."))
 sys.path.insert(0, os.path.abspath("../../shapiq"))
 
 import shapiq
 
 # -- Read the Docs ---------------------------------------------------------------------------------
-master_doc = 'index'
+master_doc = "index"
 
 # -- Project information ---------------------------------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-project = 'shapiq'
-copyright = '2023, the shapiq developers'
-author = 'Maximilian Muschalik and Fabian Fumagalli'
+project = "shapiq"
+copyright = "2023, the shapiq developers"
+author = "Maximilian Muschalik and Fabian Fumagalli"
 release = shapiq.__version__
 version = shapiq.__version__
 
@@ -34,15 +36,15 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.autosummary",
-    'sphinx_copybutton',
+    "sphinx_copybutton",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosectionlabel",
     "sphinx_autodoc_typehints",
     "sphinx_toolbox.more_autodoc.autoprotocol",
 ]
 
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 source_suffix = {
     ".rst": "restructuredtext",
@@ -59,9 +61,9 @@
 
 # -- Options for HTML output -----------------------------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-html_theme = 'furo'
+html_theme = "furo"
 html_static_path = ["_static"]
-html_favicon = '_static/shapiq.ico'
+html_favicon = "_static/shapiq.ico"
 pygments_dark_style = "monokai"
 html_theme_options = {
     "sidebar_hide_name": True,
@@ -83,19 +85,22 @@
 # -- Autodoc ---------------------------------------------------------------------------------------
 autosummary_generate = True
 autodoc_default_options = {
-    'show-inheritance': True,
-    'members': True,
-    'member-order': 'groupwise',
-    'special-members': '__call__',
-    'undoc-members': True,
-    'exclude-members': '__weakref__'
+    "show-inheritance": True,
+    "members": True,
+    "member-order": "groupwise",
+    "special-members": "__call__",
+    "undoc-members": True,
+    "exclude-members": "__weakref__",
 }
-autoclass_content = 'class'
+autoclass_content = "class"
 autodoc_inherit_docstrings = False
 
 # -- Images ----------------------------------------------------------------------------------------
 StandaloneHTMLBuilder.supported_image_types = [
-    "image/svg+xml", "image/gif", "image/png", "image/jpeg"
+    "image/svg+xml",
+    "image/gif",
+    "image/png",
+    "image/jpeg",
 ]
 # -- Copy Paste Button -----------------------------------------------------------------------------
 # Ignore >>> when copying code