From 7983846cd82083ee7ede95376347311a8e907a98 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Thu, 17 Nov 2016 16:35:37 +0000
Subject: [PATCH] Documentation updates
---
doc/fsl.data.vest.rst | 9 +++++++++
doc/fsl.rst | 1 +
doc/fsl.scripts.imcp.rst | 9 +++++++++
doc/fsl.scripts.immv.rst | 9 +++++++++
doc/fsl.scripts.rst | 13 +++++++++++++
fsl/__init__.py | 5 +++--
6 files changed, 44 insertions(+), 2 deletions(-)
create mode 100644 doc/fsl.data.vest.rst
create mode 100644 doc/fsl.scripts.imcp.rst
create mode 100644 doc/fsl.scripts.immv.rst
create mode 100644 doc/fsl.scripts.rst
diff --git a/doc/fsl.data.vest.rst b/doc/fsl.data.vest.rst
new file mode 100644
index 000000000..ec61be5e9
--- /dev/null
+++ b/doc/fsl.data.vest.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+fsl.data.vest module
+====================
+
+.. automodule:: fsl.data.vest
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.rst b/doc/fsl.rst
index cb3575e0b..068c1101a 100644
--- a/doc/fsl.rst
+++ b/doc/fsl.rst
@@ -7,6 +7,7 @@ fsl package
fsl.version
fsl.utils
fsl.data
+ fsl.scripts
.. automodule:: fsl
:members:
diff --git a/doc/fsl.scripts.imcp.rst b/doc/fsl.scripts.imcp.rst
new file mode 100644
index 000000000..f49e559a7
--- /dev/null
+++ b/doc/fsl.scripts.imcp.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+fsl.scripts.imcp module
+=======================
+
+.. automodule:: fsl.scripts.imcp
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.scripts.immv.rst b/doc/fsl.scripts.immv.rst
new file mode 100644
index 000000000..b53c2d6d4
--- /dev/null
+++ b/doc/fsl.scripts.immv.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+fsl.scripts.immv module
+=======================
+
+.. automodule:: fsl.scripts.immv
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.scripts.rst b/doc/fsl.scripts.rst
new file mode 100644
index 000000000..ecd7ccef0
--- /dev/null
+++ b/doc/fsl.scripts.rst
@@ -0,0 +1,13 @@
+fsl.scripts package
+===================
+
+.. toctree::
+ :hidden:
+
+ fsl.scripts.imcp
+ fsl.scripts.immv
+
+.. automodule:: fsl.scripts
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/fsl/__init__.py b/fsl/__init__.py
index 31faab1ed..bc2013870 100644
--- a/fsl/__init__.py
+++ b/fsl/__init__.py
@@ -6,13 +6,14 @@
# Author: Paul McCarthy <pauldmccarthy@gmail.com>
#
"""The :mod:`fsl` package is a library which contains convenience classes
-and functions for use by FSL python tools. It is broadly split into two
-sub-packages:
+and functions for use by FSL python tools. It is broadly split into the
+following sub-packages:
.. autosummary::
fsl.data
fsl.utils
+ fsl.scripts
.. note:: The ``fslpy`` version number (currently |version|) is set in a
single place - the :mod:`fsl.version` module.
--
GitLab