document sample io functions

mu-biomed · Apr 10, 2023 · 6c821b9 · 6c821b9
1 parent 6a41681
commit 6c821b9
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 1 deletion.
diff --git a/doc/functions.rst b/doc/functions.rst
@@ -0,0 +1,32 @@
+=========
+Functions
+=========
+
+These are the functions implemented in RETIMAT
+
+
+File reading
+============
+.. automodule:: io
+.. autofunction:: io.read_xml_iowa
+
+----
+
+.. autofunction:: io.read_bin
+
+----
+
+.. autofunction:: io.read_e2e
+
+----
+
+.. autofunction:: io.read_vol
+
+----
+
+.. autofunction:: io.read_fda
+
+
+Spatial analysis
+================
+
diff --git a/doc/index.rst b/doc/index.rst
@@ -10,7 +10,7 @@ Welcome to RETIMAT's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-
+   functions
 
 Indices and tables
 ==================