style: format with ruff

docs/conf.py

@@ -5,29 +5,29 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../src'))
-sys.path.insert(0, os.path.abspath('../src/aare'))
-sys.path.insert(0, os.path.abspath('../src/aare/daq'))
-sys.path.insert(0, os.path.abspath('../src/aare/common'))
-sys.path.insert(0, os.path.abspath('../src/aare/gui'))
+sys.path.insert(0, os.path.abspath("../src"))
+sys.path.insert(0, os.path.abspath("../src/aare"))
+sys.path.insert(0, os.path.abspath("../src/aare/daq"))
+sys.path.insert(0, os.path.abspath("../src/aare/common"))
+sys.path.insert(0, os.path.abspath("../src/aare/gui"))
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'AareDAQ'
-copyright = '2026, Paul Scherrer Institute'
-author = 'Martin Appleby, Guillaume Gotthard, Filip Leonarski and Dawn (Jiaxin) Daun'
-release = '0.3.1'
-master_doc = 'index'
-root_doc = 'index'
+project = "AareDAQ"
+copyright = "2026, Paul Scherrer Institute"
+author = "Martin Appleby, Guillaume Gotthard, Filip Leonarski and Dawn (Jiaxin) Daun"
+release = "0.3.1"
+master_doc = "index"
+root_doc = "index"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 autodoc_mock_imports = [
-    'aaredb',
-    'jfjoch_client',
-    'numpy',
-    'requests',
+    "aaredb",
+    "jfjoch_client",
+    "numpy",
+    "requests",
     "pyJW",
     "pyzmq",
     "opencv-python-headless",
@@ -43,16 +43,16 @@ autodoc_mock_imports = [
     "psi-pshell",
 ]
 
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 extensions = [
     # 'fuse_search',
-    'sphinx.ext.intersphinx',
-    'myst_parser',
-    'sphinx_immaterial',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.intersphinx",
+    "myst_parser",
+    "sphinx_immaterial",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
 ]
 
 # Optional: allow includes in Markdown
@@ -63,11 +63,11 @@ myst_enable_extensions = [
     "html_image",
     "linkify",
     "substitution",
-    'smartquotes',
+    "smartquotes",
     "tasklist",
 ]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 myst_heading_anchor = 3
 
 
@@ -86,10 +86,10 @@ myst_heading_anchor = 3
 #     ]
 # }
 
-#Static Files
-html_static_path = ['_static']
+# Static Files
+html_static_path = ["_static"]
 html_css_files = [
-    'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/all.min.css',
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/all.min.css"
     # 'css/fuse-search.css',
 ]
 # html_js_files = [
@@ -100,11 +100,11 @@ html_css_files = [
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_immaterial'
+html_theme = "sphinx_immaterial"
 
 html_theme_options = {
     "icon": {
-        "repo": "fontawesome/brands/github", # or gitlab/gitea icon
+        "repo": "fontawesome/brands/github"  # or gitlab/gitea icon
     },
     "site_url": "https://gitea.psi.ch/mx/aaredaq",
     "repo_url": "https://gitea.psi.ch/mx/aaredaq",
@@ -114,7 +114,7 @@ html_theme_options = {
             "icon": "fontawesome/brands/github",
             "link": "https://gitea.psi.ch/mx/aaredaq",
             "name": "AareDAQ on Gitea",
-        },
+        }
     ],
     "palette": [
         {
@@ -122,20 +122,14 @@ html_theme_options = {
             "scheme": "default",
             "primary": "indigo",
             "accent": "lime",
-            "toggle": {
-                "icon": "material/lightbulb-outline",
-                "name": "Switch to dark mode",
-            },
+            "toggle": {"icon": "material/lightbulb-outline", "name": "Switch to dark mode"},
         },
         {
             "media": "(prefers-color-scheme: dark)",
             "scheme": "slate",
             "primary": "indigo",
             "accent": "lime",
-            "toggle": {
-                "icon": "material/lightbulb",
-                "name": "Switch to light mode",
-            },
+            "toggle": {"icon": "material/lightbulb", "name": "Switch to light mode"},
         },
     ],
     "features": [
@@ -152,14 +146,10 @@ html_theme_options = {
     "globaltoc_collapse": False,
     "toc_title": "On this page",
     "toc_title_container": True,
-    "font": {
-        "code": "JetBrains Mono",
-    },
+    "font": {"code": "JetBrains Mono"},
 }
 html_theme_options["google_fonts"] = []
-html_sidebars = {
-    "**": ["logo-text.html", "globaltoc.html", "searchbox.html"]
-}
+html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "searchbox.html"]}
 
 
 html_show_sourcelink = False
@@ -167,8 +157,8 @@ html_show_sourcelink = False
 
 # Optional
 autodoc_default_options = {
-    'members': True,
-    'undoc-members': True,
-    'show-inheritance': True,
-    'member-order': 'bysource',
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+    "member-order": "bysource",
 }