Changeset 274f9ef in flex_extract.git for documentation/Sphinx/source/api.rst

Timestamp:

Oct 22, 2018, 11:44:47 AM (6 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

db27c09

Parents:

708c667

Message:

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

File:

• documentation/Sphinx/source/api.rst (modified) (1 diff)

documentation/Sphinx/source/api.rst

@@ -2 +2 @@
 ============================
 
+.. contents::
+    :local:
+    
+Porgrams
+--------
+
+install
+*******
+
+.. automodule:: install
+    :members:
+    
+submit
+******
+
+.. automodule:: submit
+    :members:
+    
+Classes
+-------
+
+ControlFile
+***********
+
+.. automodule:: ControlFile
+    :members:
+    
+EcFlexpart
+**********
+
+.. automodule:: EcFlexpart
+    :members:
+    
+GribTools
+*********
+
+.. automodule:: GribTools
+    :members:
+
+MarsRetrieval
+*************
+
+.. automodule:: MarsRetrieval
+    :members:
+
+UioFiles
+********
+
+.. automodule:: UioFiles
+    :members:
+
+
+
+Modules
+-------
+
+get_mars_data
+*************
+
+.. automodule:: get_mars_data
+    :members:
+ 
+prepare_flexpart
+****************
+
+.. automodule:: prepare_flexpart
+    :members:    
+    
+tools
+*****
+
+.. automodule:: tools
+    :members:
+
+disaggregation
+**************    
+    
 .. automodule:: disaggregation
     :members: