From 372cdbdc8347c782312eaaaf133af36b44c3e14c Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Sun, 4 Mar 2018 13:11:49 +0000
Subject: [PATCH] Docs for wrappers package
---
doc/fsl.data.rst | 2 ++
doc/fsl.rst | 1 +
doc/fsl.utils.rst | 1 +
doc/fsl.wrappers.bet.rst | 7 +++++++
doc/fsl.wrappers.eddy.rst | 7 +++++++
doc/fsl.wrappers.flirt.rst | 7 +++++++
doc/fsl.wrappers.fnirt.rst | 7 +++++++
doc/fsl.wrappers.fslmaths.rst | 7 +++++++
doc/fsl.wrappers.fugue.rst | 7 +++++++
doc/fsl.wrappers.melodic.rst | 7 +++++++
doc/fsl.wrappers.misc.rst | 7 +++++++
doc/fsl.wrappers.rst | 20 ++++++++++++++++++++
doc/fsl.wrappers.wrapperutils.rst | 7 +++++++
doc/mock_modules.txt | 1 +
14 files changed, 88 insertions(+)
create mode 100644 doc/fsl.wrappers.bet.rst
create mode 100644 doc/fsl.wrappers.eddy.rst
create mode 100644 doc/fsl.wrappers.flirt.rst
create mode 100644 doc/fsl.wrappers.fnirt.rst
create mode 100644 doc/fsl.wrappers.fslmaths.rst
create mode 100644 doc/fsl.wrappers.fugue.rst
create mode 100644 doc/fsl.wrappers.melodic.rst
create mode 100644 doc/fsl.wrappers.misc.rst
create mode 100644 doc/fsl.wrappers.rst
create mode 100644 doc/fsl.wrappers.wrapperutils.rst
diff --git a/doc/fsl.data.rst b/doc/fsl.data.rst
index 1bad68dea..f564da940 100644
--- a/doc/fsl.data.rst
+++ b/doc/fsl.data.rst
@@ -12,6 +12,7 @@
fsl.data.featdesign
fsl.data.featimage
fsl.data.fixlabels
+ fsl.data.freesurfer
fsl.data.gifti
fsl.data.image
fsl.data.imagewrapper
@@ -21,6 +22,7 @@
fsl.data.mghimage
fsl.data.vest
fsl.data.volumelabels
+ fsl.data.vtk
.. automodule:: fsl.data
:members:
diff --git a/doc/fsl.rst b/doc/fsl.rst
index c8e5bb118..fb702bca8 100644
--- a/doc/fsl.rst
+++ b/doc/fsl.rst
@@ -8,6 +8,7 @@
fsl.scripts
fsl.utils
fsl.version
+ fsl.wrappers
.. automodule:: fsl
:members:
diff --git a/doc/fsl.utils.rst b/doc/fsl.utils.rst
index 41f3669eb..f460cbfb3 100644
--- a/doc/fsl.utils.rst
+++ b/doc/fsl.utils.rst
@@ -10,6 +10,7 @@
fsl.utils.idle
fsl.utils.imcp
fsl.utils.memoize
+ fsl.utils.meta
fsl.utils.naninfrange
fsl.utils.notifier
fsl.utils.path
diff --git a/doc/fsl.wrappers.bet.rst b/doc/fsl.wrappers.bet.rst
new file mode 100644
index 000000000..a2c46e9d1
--- /dev/null
+++ b/doc/fsl.wrappers.bet.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.bet``
+====================
+
+.. automodule:: fsl.wrappers.bet
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.eddy.rst b/doc/fsl.wrappers.eddy.rst
new file mode 100644
index 000000000..406bdb5b6
--- /dev/null
+++ b/doc/fsl.wrappers.eddy.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.eddy``
+=====================
+
+.. automodule:: fsl.wrappers.eddy
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.flirt.rst b/doc/fsl.wrappers.flirt.rst
new file mode 100644
index 000000000..855758af9
--- /dev/null
+++ b/doc/fsl.wrappers.flirt.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.flirt``
+======================
+
+.. automodule:: fsl.wrappers.flirt
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.fnirt.rst b/doc/fsl.wrappers.fnirt.rst
new file mode 100644
index 000000000..5fc0a992b
--- /dev/null
+++ b/doc/fsl.wrappers.fnirt.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.fnirt``
+======================
+
+.. automodule:: fsl.wrappers.fnirt
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.fslmaths.rst b/doc/fsl.wrappers.fslmaths.rst
new file mode 100644
index 000000000..22c697ec7
--- /dev/null
+++ b/doc/fsl.wrappers.fslmaths.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.fslmaths``
+=========================
+
+.. automodule:: fsl.wrappers.fslmaths
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.fugue.rst b/doc/fsl.wrappers.fugue.rst
new file mode 100644
index 000000000..93d450140
--- /dev/null
+++ b/doc/fsl.wrappers.fugue.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.fugue``
+======================
+
+.. automodule:: fsl.wrappers.fugue
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.melodic.rst b/doc/fsl.wrappers.melodic.rst
new file mode 100644
index 000000000..2400879c7
--- /dev/null
+++ b/doc/fsl.wrappers.melodic.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.melodic``
+========================
+
+.. automodule:: fsl.wrappers.melodic
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.misc.rst b/doc/fsl.wrappers.misc.rst
new file mode 100644
index 000000000..fb3015f41
--- /dev/null
+++ b/doc/fsl.wrappers.misc.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.misc``
+=====================
+
+.. automodule:: fsl.wrappers.misc
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.rst b/doc/fsl.wrappers.rst
new file mode 100644
index 000000000..4c9a2950e
--- /dev/null
+++ b/doc/fsl.wrappers.rst
@@ -0,0 +1,20 @@
+``fsl.wrappers``
+================
+
+.. toctree::
+ :hidden:
+
+ fsl.wrappers.bet
+ fsl.wrappers.eddy
+ fsl.wrappers.flirt
+ fsl.wrappers.fnirt
+ fsl.wrappers.fslmaths
+ fsl.wrappers.fugue
+ fsl.wrappers.melodic
+ fsl.wrappers.misc
+ fsl.wrappers.wrapperutils
+
+.. automodule:: fsl.wrappers
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.wrapperutils.rst b/doc/fsl.wrappers.wrapperutils.rst
new file mode 100644
index 000000000..27e13abb0
--- /dev/null
+++ b/doc/fsl.wrappers.wrapperutils.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.wrapperutils``
+=============================
+
+.. automodule:: fsl.wrappers.wrapperutils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/mock_modules.txt b/doc/mock_modules.txt
index 8004b2a20..8bb6c230a 100644
--- a/doc/mock_modules.txt
+++ b/doc/mock_modules.txt
@@ -1,6 +1,7 @@
deprecation
nibabel
nibabel.fileslice
+nibabel.freesurfer
numpy
numpy.linalg
scipy
--
GitLab