/
Documentation_building.txt
33 lines (22 loc) · 1.31 KB
/
Documentation_building.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# This framework evolved from a collaboration of:
# - Research Laboratory of Electronics, Massachusetts Institute of Technology, Cambdrige, MA, US
# - Pattern Recognition Lab, Friedrich-Alexander-Universitaet Erlangen-Nuernberg, Germany
# - Department of Biomedical Engineering, Peking University, Beijing, China
# - New England Eye Center, Tufts Medical Center, Boston, MA, US
# v1.0: Updated on Mar 20, 2019
# @author: Daniel Stromer - EMAIL:daniel.stromer@fau.de
# Copyright (C) 2018-2019 - Daniel Stromer
# PRLE is developed as an Open Source project under the GNU General Public License (GPL) v3.0.
The documentation was build using sphinx (http://www.sphinx-doc.org/).
All files for the documentation are located in the "doc" directory.
If you add a new module, etc., and want to document it, you have to create a '.rst' file in "doc".
Assuming the new pyhton module is named "TestClass.py" located in "OCT_GUI/TestPackage/", the file
should be created as follows.
1) Name the file TestClass.rst and add the content.
ATTENTION: Before :members:, you MUST ENTER EXACTLY 3 SPACES
.. automodule:: OCT_GUI.TestPackage.TestClass
:members:
2) Open index.rst and add (ATTENTION: Before TestClass, you MUST ENTER EXACTLY 3 SPACES )
TestClass
3) In your command prompt, change to the "doc" directory and run
make html