🔧 Add blacken-docs

* Fix Python syntax

Author: veit

.pre-commit-config.yaml

@@ -33,6 +33,13 @@ repos:
     rev: 24.8.0
     hooks:
     - id: black
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.18.0"
+    hooks:
+    - id: blacken-docs
+      args: [--line-length=79]
+      additional_dependencies:
+      - black
   - repo: local
     hooks:
     - id: linkcheck

docs/dashboards/voila/templating.rst

@@ -46,26 +46,38 @@ Then you can create a layout, for example with:
 
 .. code-block:: python
 
-    v.Tabs(_metadata={'mount_id': 'content-main'}, children=[
-        v.Tab(children=['Tab1']),
-        v.Tab(children=['Tab2']),
-        v.TabItem(children=[
-            v.Layout(row=True, wrap=True, align_center=True, children=[
-                v.Flex(xs12=True, lg6=True, xl4=True, children=[
-                    fig, slider
-                ]),
-                v.Flex(xs12=True, lg6=True, xl4=True, children=[
-                    figHist2, sliderHist2
-                ]),
-                v.Flex(xs12=True, xl4=True, children=[
-                    fig2
-                ]),
-            ])
-        ]),
-        v.TabItem(children=[
-            v.Container(children=['Lorum ipsum'])
-        ])
-    ])
+    v.Tabs(
+        _metadata={"mount_id": "content-main"},
+        children=[
+            v.Tab(children=["Tab1"]),
+            v.Tab(children=["Tab2"]),
+            v.TabItem(
+                children=[
+                    v.Layout(
+                        row=True,
+                        wrap=True,
+                        align_center=True,
+                        children=[
+                            v.Flex(
+                                xs12=True,
+                                lg6=True,
+                                xl4=True,
+                                children=[fig, slider],
+                            ),
+                            v.Flex(
+                                xs12=True,
+                                lg6=True,
+                                xl4=True,
+                                children=[figHist2, sliderHist2],
+                            ),
+                            v.Flex(xs12=True, xl4=True, children=[fig2]),
+                        ],
+                    )
+                ]
+            ),
+            v.TabItem(children=[v.Container(children=["Lorum ipsum"])]),
+        ],
+    )
 
 You can use :doc:`bqplot_vuetify_example` with:
 
@@ -124,9 +136,11 @@ kernel:
 
     import os
 
+
     def kill_kernel(change):
         os._exit(0)
 
+
     button = widgets.Button(description="Kill Kernel")
     button.on_click(kill_kernel)
     button

docs/hub/config.rst

@@ -34,7 +34,9 @@ System Service for JupyterHub
 
    .. code-block:: python
 
-    c.Spawner.cmd = ['/srv/jupyter/.local/share/virtualenvs/jupyter-tutorial-aFv4x91/bin/jupyterhub-singleuser']
+    c.Spawner.cmd = [
+        "/srv/jupyter/.local/share/virtualenvs/jupyter-tutorial-aFv4x91/bin/jupyterhub-singleuser"
+    ]
 
 #. Add a new systemd unit file :file:`/etc/systemd/system/jupyterhub.service`
    with the command:
@@ -186,7 +188,7 @@ authentication.
 
    .. code-block:: python
 
-    c.JupyterHub.cookie_secret_file = 'jupyterhub_cookie_secret'
+    c.JupyterHub.cookie_secret_file = "jupyterhub_cookie_secret"
 
 Proxy authentication token
 --------------------------
@@ -206,4 +208,6 @@ to be restarted every time unless the proxy is a subprocess of the hub.
 
    .. code-block:: python
 
-    c.JupyterHub.proxy_auth_token = '18a0335b7c2e7edeaf7466894a32bea8d1c3cff4b07860298dbe353ecb179fc6'
+    c.JupyterHub.proxy_auth_token = (
+        "18a0335b7c2e7edeaf7466894a32bea8d1c3cff4b07860298dbe353ecb179fc6"
+    )

docs/hub/ipyparallel/config.rst

@@ -45,7 +45,7 @@ when the IPython hub is started, usually in
 
    .. code-block:: python
 
-        c.IPClusterEngines.engine_launcher_class = 'MPIEngineSetLauncher'
+        c.IPClusterEngines.engine_launcher_class = "MPIEngineSetLauncher"
 
 #. The cluster can then be started with:
 

docs/hub/systemdspawner.rst

@@ -49,7 +49,7 @@ Then you can activate it in :file:`jupyterhub_config.py` with
 
 .. code-block:: python
 
-   c.JupyterHub.spawner_class = 'systemdspawner.SystemdSpawner'
+   c.JupyterHub.spawner_class = "systemdspawner.SystemdSpawner"
 
 There are many other configuration options open to you, for example
 

docs/nbconvert.rst

@@ -108,15 +108,18 @@ Use on the command line
 
         # # `foo.ipynb`
 
+
         # In[1]:
         def bar():
             return "bar"
 
+
         # In[2]:
         def has_ip_syntax():
             listing = get_ipython().getoutput("ls")
             return listing
 
+
         # In[3]:
         def whatsmyname():
             return __name__

docs/nbextensions/list.rst

@@ -120,7 +120,7 @@ Hereinafter I will give a brief overview of some of the notebook extensions.
 
     .. code-block:: python
 
-        c.CodeFoldingPreprocessor.remove_folded_code=True = True
+        c.CodeFoldingPreprocessor.remove_folded_code = True
 
     or on the command line with:
 

docs/notebook/config.rst

@@ -52,7 +52,7 @@ supplemented with  ``append``, ``extend``, ``prepend``, ``add`` and
 
 .. code-block:: python
 
-    c.TemplateExporter.template_path.append('./templates')
+    c.TemplateExporter.template_path.append("./templates")
 
 … with the command line
 ~~~~~~~~~~~~~~~~~~~~~~~

docs/sphinx/nbsphinx.rst

@@ -36,15 +36,13 @@ Configure Sphinx
 
    .. code-block:: python
 
-    extensions = [
-        ...
-        "nbsphinx",
-    ]
-    ...
-    exclude_patterns = [
-        ...
-        "**/.ipynb_checkpoints",
-    ]
+      extensions = [
+          "nbsphinx",
+      ]
+
+      exclude_patterns = [
+          "**/.ipynb_checkpoints",
+      ]
 
    You can find an example in the :download:`/conf.py` file of the Jupyter
    tutorial.