DOC: Fix autodoc parsing

psychopy · Apr 15, 2024 · b1db590 · b1db590
1 parent 1cab839
commit b1db590
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/docs_sphinx/coder/EnvelopeGrating.rst b/docs_sphinx/coder/EnvelopeGrating.rst
@@ -1,3 +1,7 @@
+-------------------------------
+Envelope Grating
+-------------------------------
+
 To import EnvelopeGrating, you can either use:
 ```python
 from psychopy_visionscience.secondorder import EnvelopeGrating
@@ -7,4 +11,5 @@ or, any time after `psychopy.plugins.activatePlugins` has been called:
 from psychopy.visual import EnvelopeGrating
 ```
 
-.. automodule:: psychopy_visionscience.secondorder.EnvelopeGrating
+.. autoclass:: psychopy_visionscience.secondorder.EnvelopeGrating
+    :members:
diff --git a/docs_sphinx/coder/NoiseStim.rst b/docs_sphinx/coder/NoiseStim.rst
@@ -1,3 +1,7 @@
+-------------------------------
+Noise Stim
+-------------------------------
+
 To import NoiseStim, you can either use:
 ```python
 from psychopy_visionscience.noise import NoiseStim
@@ -7,4 +11,5 @@ or, any time after `psychopy.plugins.activatePlugins` has been called:
 from psychopy.visual import NoiseStim
 ```
 
-.. automodule:: psychopy_visionscience.noise.NoiseStim
+.. autoclass:: psychopy_visionscience.noise.NoiseStim
+    :members:
diff --git a/docs_sphinx/coder/RadialStim.rst b/docs_sphinx/coder/RadialStim.rst
@@ -1,3 +1,7 @@
+-------------------------------
+Radial Stim
+-------------------------------
+
 To import RadialStim, you can either use:
 ```python
 from psychopy_visionscience.radial import RadialStim
@@ -7,4 +11,5 @@ or, any time after `psychopy.plugins.activatePlugins` has been called:
 from psychopy.visual import RadialStim
 ```
 
-.. automodule:: psychopy_visionscience.radial.RadialStim
+.. autoclass:: psychopy_visionscience.radial.RadialStim
+    :members:
diff --git a/psychopy_visionscience/secondorder.py b/psychopy_visionscience/secondorder.py
@@ -71,9 +71,9 @@
 class EnvelopeGrating(GratingStim):
     """Second-order envelope stimuli with 3 textures; a carrier, an envelope and a mask
 
-    **Examples**::
+    **Examples**
 
-    ```python
+    
     env1 = EnvelopeGrating(win,ori=0, carrier='sin', envelope='sin',
             mask = 'gauss', sf=24, envsf=4, size=1, contrast=0.5,
             moddepth=1.0, envori=0, pos=[-.5,.5],interpolate=0)
@@ -91,7 +91,7 @@ class EnvelopeGrating(GratingStim):
             # critically contains no net energy at the carrier frequency
             # even though it appears to be present. In this case carrier
             # and envelope are at 90 degree to each other
-    ```
+    
 
     With an EnvelopeStim the carrier and envelope can have different spatial
     frequencies, phases and orientations. Its position can be shifted as a whole.