Skip to content

Commit 4400ab9

Browse files
committed
add headings to function description doc
1 parent e752460 commit 4400ab9

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/source/function_description.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Function description
2-
====================
2+
********************
33

44
The functions of our pipeline
55

@@ -21,6 +21,9 @@ List of functions in the ``src`` folder.
2121

2222
----
2323

24+
Aperture
25+
========
26+
2427
List of functions in the ``src/aperture`` folder.
2528

2629
(to add saveAperture)
@@ -36,6 +39,9 @@ List of functions in the ``src/aperture`` folder.
3639

3740
----
3841

42+
Dot
43+
===
44+
3945
List of functions in the ``src/dot`` folder.
4046

4147
.. module:: src.dot
@@ -54,6 +60,9 @@ List of functions in the ``src/dot`` folder.
5460

5561
----
5662

63+
Errors
64+
======
65+
5766
List of functions in the ``src/errors`` folder.
5867

5968
.. module:: src.errors
@@ -65,6 +74,9 @@ List of functions in the ``src/errors`` folder.
6574

6675
----
6776

77+
Fixation
78+
========
79+
6880
List of functions in the ``src/fixation`` folder.
6981

7082
.. module:: src.fixation
@@ -74,6 +86,9 @@ List of functions in the ``src/fixation`` folder.
7486

7587
----
7688

89+
Keyboard
90+
========
91+
7792
List of functions in the ``src/keyboard`` folder.
7893

7994
.. module:: src.keyboard
@@ -87,6 +102,9 @@ List of functions in the ``src/keyboard`` folder.
87102

88103
----
89104

105+
Randomization
106+
=============
107+
90108
List of functions in the ``src/randomization`` folder.
91109

92110
.. module:: src.randomization
@@ -97,6 +115,9 @@ List of functions in the ``src/randomization`` folder.
97115

98116
----
99117

118+
Screen
119+
======
120+
100121
List of functions in the ``src/screen`` folder.
101122

102123
.. module:: src.screen
@@ -106,6 +127,9 @@ List of functions in the ``src/screen`` folder.
106127

107128
----
108129

130+
Utilities
131+
=========
132+
109133
List of functions in the ``src/utils`` folder.
110134

111135
(to add makeGif)

0 commit comments

Comments
 (0)