Skip to content

Commit c49eb8f

Browse files
marcobarilarimarcobarilari
committed
add all the function to sphinx function description
1 parent e47f8dd commit c49eb8f

File tree

1 file changed

+98
-4
lines changed

1 file changed

+98
-4
lines changed

‎docs/source/function_description.rst‎

Lines changed: 98 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ The functions of our pipeline
55

66
----
77

8-
List of functions in the ``src`` folder.
8+
List of functions in the ``src`` folder.
99

1010
.. module:: src
1111

12-
.. autofunction:: initPTB()
12+
.. autofunction:: initPTB
1313
.. autofunction:: drawFieldOfVIew
1414
.. autofunction:: eyeTracker
1515
.. autofunction:: getExperimentEnd
@@ -25,8 +25,102 @@ List of functions in the ``src`` folder.
2525

2626
----
2727

28+
List of functions in the ``src/aperture`` folder.
29+
30+
.. module:: src.aperture
31+
32+
.. autofunction:: apertureTexture
33+
.. autofunction:: eccenLogSpeed
34+
.. autofunction:: getApertureName
35+
.. autofunction:: saveAperture
36+
.. autofunction:: saveApertures
37+
.. autofunction:: smoothOval
38+
.. autofunction:: smoothRect
39+
40+
----
41+
42+
List of functions in the ``src/dot`` folder.
43+
44+
.. module:: src.dot
45+
46+
.. autofunction:: computeCartCoord
47+
.. autofunction:: computeRadialMotionDirection
48+
.. autofunction:: decomposeMotion
49+
.. autofunction:: dotMotionSimulation
50+
.. autofunction:: dotTexture
51+
.. autofunction:: generateNewDotPositions
52+
.. autofunction:: initDots
53+
.. autofunction:: reseedDots
54+
.. autofunction:: seedDots
55+
.. autofunction:: setDotDirection
56+
.. autofunction:: updateDots
57+
58+
----
59+
60+
List of functions in the ``src/errors`` folder.
61+
62+
.. module:: src.errors
63+
64+
.. autofunction:: errorAbort
65+
.. autofunction:: errorAbortGetReponse
66+
.. autofunction:: errorDistanceToScreen
67+
.. autofunction:: errorRestrictedKeysGetReponse
68+
69+
----
70+
71+
List of functions in the ``src/fixation`` folder.
72+
73+
.. module:: src.fixation
74+
75+
.. autofunction:: drawFixation
76+
.. autofunction:: initFixation
77+
78+
----
79+
80+
List of functions in the ``src/keyboard`` folder.
81+
2882
.. module:: src.keyboard
2983

30-
.. autofunction:: getResponse()
84+
.. autofunction:: getResponse
85+
.. autofunction:: checkAbort
86+
.. autofunction:: checkAbortGetResponse
87+
.. autofunction:: collectAndSaveResponses
88+
.. autofunction:: pressSpaceForMe
89+
.. autofunction:: testKeyboards
90+
91+
----
92+
93+
List of functions in the ``src/randomization`` folder.
94+
95+
.. module:: src.randomization
96+
97+
.. autofunction:: repeatShuffleConditions
98+
.. autofunction:: setTargetPositionInSequence
99+
.. autofunction:: shuffle
100+
101+
----
102+
103+
List of functions in the ``src/screen`` folder.
104+
105+
.. module:: src.screen
106+
107+
.. autofunction:: farewellScreen
108+
.. autofunction:: standByScreen
109+
110+
----
111+
112+
List of functions in the ``src/utils`` folder.
113+
114+
.. module:: src.utils
31115

32-
.. autofunction:: checkAbort()
116+
.. autofunction:: checkPtbVersion
117+
.. autofunction:: cleanUp
118+
.. autofunction:: computeFOV
119+
.. autofunction:: degToPix
120+
.. autofunction:: makeGif
121+
.. autofunction:: pixToDeg
122+
.. autofunction:: printCreditsCppPtb
123+
.. autofunction:: printScreen
124+
.. autofunction:: setDefaults
125+
.. autofunction:: setDefaultsPTB
126+
.. autofunction:: setUpRand

0 commit comments

Comments
 (0)