Fix docstring and doc warning

hyperspy · Nov 16, 2023 · 3ae7a3a · 3ae7a3a
1 parent 4c15907
commit 3ae7a3a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 9 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -6,3 +6,8 @@ jobs:
   Build:
     # Use the "reusable workflow" from the hyperspy organisation
     uses: hyperspy/.github/.github/workflows/doc.yml@main
+    with:
+      # install with speed extra to avoid warnings
+      pip_extra_doc: 'doc,speed'
+      # graphviz is required to build mermaid graph
+      install_package_ubuntu: graphviz
diff --git a/hyperspy/_components/scalable_fixed_pattern.py b/hyperspy/_components/scalable_fixed_pattern.py
@@ -41,15 +41,6 @@ class ScalableFixedPattern(Component):
      :math:`x_0`  shift
     ============ =============
 
-
-    The fixed pattern is defined by a single spectrum which must be provided to
-    the ScalableFixedPattern constructor, e.g.:
-
-    .. code-block:: ipython
-
-        In [1]: s = load('my_spectrum.hspy')
-        In [2]: my_fixed_pattern = components.ScalableFixedPattern(s))
-
     Parameters
     ----------
 
@@ -65,6 +56,15 @@ class ScalableFixedPattern(Component):
 
     prepare_interpolator : method to fine tune the interpolation
 
+    Examples
+    --------
+
+    The fixed pattern is defined by a single spectrum which must be provided to
+    the ScalableFixedPattern constructor, e.g.:
+    
+    >>> s = hs.load('my_spectrum.hspy')
+    >>> my_fixed_pattern = hs.model.components1D.ScalableFixedPattern(s)
+    
     """
 
     def __init__(self, signal1D, yscale=1.0, xscale=1.0,