Merge pull request #74 from iterorganization/fail-docs-ci-on-warn

Fail CI if there are warnings when building docs

Author: maarten-ic

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -W
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 GENERATEDDIR  = $(SOURCEDIR)/generated

pyproject.toml

@@ -48,6 +48,7 @@ test = [
     "pytest-randomly",
 ]
 docs = [
+    "waveform-editor[muscle3]",
     "sphinx>=6.0.0,<7.0.0",
     "sphinx-autosummary-accessors>=0.1.2",
     "sphinx-immaterial>=0.11.0,<0.12",

waveform_editor/util.py

@@ -43,17 +43,19 @@ class State:
 
     Example:
 
-        ignore_clicks = State()
-        def process(obj):
-            if ignore_clicks:
-                return
-            ...
-        widget = pn.widgets.Button(name="Process", on_click=process)
-
-        # Elsewhere we can use a with statement to temporarily ignore clicks:
-        with ignore_clicks:
-            # process will not do anything, even though the on_click triggers
-            widget.clicks = 0
+        .. code-block:: python
+
+            ignore_clicks = State()
+            def process(obj):
+                if ignore_clicks:
+                    return
+                ...
+            widget = pn.widgets.Button(name="Process", on_click=process)
+
+            # Elsewhere we can use a with statement to temporarily ignore clicks:
+            with ignore_clicks:
+                # process will not do anything, even though the on_click triggers
+                widget.clicks = 0
     """
 
     def __init__(self):