From c73c918aacbd107520927033ea6d2222ad099aa0 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Fri, 27 Oct 2017 19:02:39 +0100
Subject: [PATCH] Doc tweaks
---
doc/fsl.data.atlases.rst | 6 ++----
doc/fsl.data.constants.rst | 6 ++----
doc/fsl.data.dtifit.rst | 6 ++----
doc/fsl.data.featanalysis.rst | 6 ++----
doc/fsl.data.featdesign.rst | 6 ++----
doc/fsl.data.featimage.rst | 6 ++----
doc/fsl.data.fixlabels.rst | 6 ++----
doc/fsl.data.gifti.rst | 6 ++----
doc/fsl.data.image.rst | 6 ++----
doc/fsl.data.imagewrapper.rst | 6 ++----
doc/fsl.data.melodicanalysis.rst | 6 ++----
doc/fsl.data.melodicimage.rst | 6 ++----
doc/fsl.data.mesh.rst | 6 ++----
doc/fsl.data.rst | 6 +++---
doc/fsl.data.vest.rst | 6 ++----
doc/fsl.data.volumelabels.rst | 6 ++----
doc/fsl.rst | 8 ++++----
doc/fsl.scripts.imcp.rst | 6 ++----
doc/fsl.scripts.immv.rst | 6 ++----
doc/fsl.scripts.rst | 4 ++--
doc/fsl.utils.async.rst | 6 ++----
doc/fsl.utils.cache.rst | 6 ++----
doc/fsl.utils.callfsl.rst | 6 ++----
doc/fsl.utils.imcp.rst | 6 ++----
doc/fsl.utils.memoize.rst | 6 ++----
doc/fsl.utils.notifier.rst | 6 ++----
doc/fsl.utils.path.rst | 6 ++----
doc/fsl.utils.platform.rst | 6 ++----
doc/fsl.utils.rst | 5 +++--
doc/fsl.utils.settings.rst | 6 ++----
doc/fsl.utils.transform.rst | 6 ++----
doc/fsl.utils.weakfuncref.rst | 6 ++----
doc/fsl.version.rst | 6 ++----
33 files changed, 70 insertions(+), 127 deletions(-)
diff --git a/doc/fsl.data.atlases.rst b/doc/fsl.data.atlases.rst
index 9cd7ad336..7378bda70 100644
--- a/doc/fsl.data.atlases.rst
+++ b/doc/fsl.data.atlases.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.atlases module
-=======================
+``fsl.data.atlases``
+====================
.. automodule:: fsl.data.atlases
:members:
diff --git a/doc/fsl.data.constants.rst b/doc/fsl.data.constants.rst
index 96a40ad03..e8d748e27 100644
--- a/doc/fsl.data.constants.rst
+++ b/doc/fsl.data.constants.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.constants module
-=========================
+``fsl.data.constants``
+======================
.. automodule:: fsl.data.constants
:members:
diff --git a/doc/fsl.data.dtifit.rst b/doc/fsl.data.dtifit.rst
index 4cde0ccd4..f56824cd5 100644
--- a/doc/fsl.data.dtifit.rst
+++ b/doc/fsl.data.dtifit.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.dtifit module
-======================
+``fsl.data.dtifit``
+===================
.. automodule:: fsl.data.dtifit
:members:
diff --git a/doc/fsl.data.featanalysis.rst b/doc/fsl.data.featanalysis.rst
index 9ff9fb16f..c6ba45c8e 100644
--- a/doc/fsl.data.featanalysis.rst
+++ b/doc/fsl.data.featanalysis.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.featanalysis module
-============================
+``fsl.data.featanalysis``
+=========================
.. automodule:: fsl.data.featanalysis
:members:
diff --git a/doc/fsl.data.featdesign.rst b/doc/fsl.data.featdesign.rst
index daacb125a..f5196e117 100644
--- a/doc/fsl.data.featdesign.rst
+++ b/doc/fsl.data.featdesign.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.featdesign module
-==========================
+``fsl.data.featdesign``
+=======================
.. automodule:: fsl.data.featdesign
:members:
diff --git a/doc/fsl.data.featimage.rst b/doc/fsl.data.featimage.rst
index f97692f41..7db6aa5c4 100644
--- a/doc/fsl.data.featimage.rst
+++ b/doc/fsl.data.featimage.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.featimage module
-=========================
+``fsl.data.featimage``
+======================
.. automodule:: fsl.data.featimage
:members:
diff --git a/doc/fsl.data.fixlabels.rst b/doc/fsl.data.fixlabels.rst
index 49599d9f9..3c76d4e37 100644
--- a/doc/fsl.data.fixlabels.rst
+++ b/doc/fsl.data.fixlabels.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.fixlabels module
-=========================
+``fsl.data.fixlabels``
+======================
.. automodule:: fsl.data.fixlabels
:members:
diff --git a/doc/fsl.data.gifti.rst b/doc/fsl.data.gifti.rst
index a3ccb0ccf..f5674f3a8 100644
--- a/doc/fsl.data.gifti.rst
+++ b/doc/fsl.data.gifti.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.gifti module
-=====================
+``fsl.data.gifti``
+==================
.. automodule:: fsl.data.gifti
:members:
diff --git a/doc/fsl.data.image.rst b/doc/fsl.data.image.rst
index ae7549eba..69ca05fcb 100644
--- a/doc/fsl.data.image.rst
+++ b/doc/fsl.data.image.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.image module
-=====================
+``fsl.data.image``
+==================
.. automodule:: fsl.data.image
:members:
diff --git a/doc/fsl.data.imagewrapper.rst b/doc/fsl.data.imagewrapper.rst
index 5f8b7a0f7..941deece6 100644
--- a/doc/fsl.data.imagewrapper.rst
+++ b/doc/fsl.data.imagewrapper.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.imagewrapper module
-============================
+``fsl.data.imagewrapper``
+=========================
.. automodule:: fsl.data.imagewrapper
:members:
diff --git a/doc/fsl.data.melodicanalysis.rst b/doc/fsl.data.melodicanalysis.rst
index 0c61211c5..9136b8433 100644
--- a/doc/fsl.data.melodicanalysis.rst
+++ b/doc/fsl.data.melodicanalysis.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.melodicanalysis module
-===============================
+``fsl.data.melodicanalysis``
+============================
.. automodule:: fsl.data.melodicanalysis
:members:
diff --git a/doc/fsl.data.melodicimage.rst b/doc/fsl.data.melodicimage.rst
index 448af5918..7c750b68f 100644
--- a/doc/fsl.data.melodicimage.rst
+++ b/doc/fsl.data.melodicimage.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.melodicimage module
-============================
+``fsl.data.melodicimage``
+=========================
.. automodule:: fsl.data.melodicimage
:members:
diff --git a/doc/fsl.data.mesh.rst b/doc/fsl.data.mesh.rst
index bdc1c781b..424f7b918 100644
--- a/doc/fsl.data.mesh.rst
+++ b/doc/fsl.data.mesh.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.mesh module
-====================
+``fsl.data.mesh``
+=================
.. automodule:: fsl.data.mesh
:members:
diff --git a/doc/fsl.data.rst b/doc/fsl.data.rst
index fd40a83d6..614c85a93 100644
--- a/doc/fsl.data.rst
+++ b/doc/fsl.data.rst
@@ -1,11 +1,12 @@
-fsl.data package
-================
+``fsl.data``
+============
.. toctree::
:hidden:
fsl.data.atlases
fsl.data.constants
+ fsl.data.dtifit
fsl.data.featanalysis
fsl.data.featdesign
fsl.data.featimage
@@ -16,7 +17,6 @@ fsl.data package
fsl.data.melodicanalysis
fsl.data.melodicimage
fsl.data.mesh
- fsl.data.dtifit
fsl.data.vest
fsl.data.volumelabels
diff --git a/doc/fsl.data.vest.rst b/doc/fsl.data.vest.rst
index ec61be5e9..ebb7d8b97 100644
--- a/doc/fsl.data.vest.rst
+++ b/doc/fsl.data.vest.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.vest module
-====================
+``fsl.data.vest``
+=================
.. automodule:: fsl.data.vest
:members:
diff --git a/doc/fsl.data.volumelabels.rst b/doc/fsl.data.volumelabels.rst
index a7533888d..48c3b03d0 100644
--- a/doc/fsl.data.volumelabels.rst
+++ b/doc/fsl.data.volumelabels.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.data.volumelabels module
-============================
+``fsl.data.volumelabels``
+=========================
.. automodule:: fsl.data.volumelabels
:members:
diff --git a/doc/fsl.rst b/doc/fsl.rst
index 068c1101a..c8e5bb118 100644
--- a/doc/fsl.rst
+++ b/doc/fsl.rst
@@ -1,13 +1,13 @@
-fsl package
-===========
+``fsl``
+=======
.. toctree::
:hidden:
- fsl.version
- fsl.utils
fsl.data
fsl.scripts
+ fsl.utils
+ fsl.version
.. automodule:: fsl
:members:
diff --git a/doc/fsl.scripts.imcp.rst b/doc/fsl.scripts.imcp.rst
index f49e559a7..da72cd38c 100644
--- a/doc/fsl.scripts.imcp.rst
+++ b/doc/fsl.scripts.imcp.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.scripts.imcp module
-=======================
+``fsl.scripts.imcp``
+====================
.. automodule:: fsl.scripts.imcp
:members:
diff --git a/doc/fsl.scripts.immv.rst b/doc/fsl.scripts.immv.rst
index b53c2d6d4..3b92e6de4 100644
--- a/doc/fsl.scripts.immv.rst
+++ b/doc/fsl.scripts.immv.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.scripts.immv module
-=======================
+``fsl.scripts.immv``
+====================
.. automodule:: fsl.scripts.immv
:members:
diff --git a/doc/fsl.scripts.rst b/doc/fsl.scripts.rst
index ecd7ccef0..219519776 100644
--- a/doc/fsl.scripts.rst
+++ b/doc/fsl.scripts.rst
@@ -1,5 +1,5 @@
-fsl.scripts package
-===================
+``fsl.scripts``
+===============
.. toctree::
:hidden:
diff --git a/doc/fsl.utils.async.rst b/doc/fsl.utils.async.rst
index 31d3ce0a8..f0388cf91 100644
--- a/doc/fsl.utils.async.rst
+++ b/doc/fsl.utils.async.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.async module
-======================
+``fsl.utils.async``
+===================
.. automodule:: fsl.utils.async
:members:
diff --git a/doc/fsl.utils.cache.rst b/doc/fsl.utils.cache.rst
index a95fa27cf..80d70d816 100644
--- a/doc/fsl.utils.cache.rst
+++ b/doc/fsl.utils.cache.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.cache module
-======================
+``fsl.utils.cache``
+===================
.. automodule:: fsl.utils.cache
:members:
diff --git a/doc/fsl.utils.callfsl.rst b/doc/fsl.utils.callfsl.rst
index 2db08b4a6..093da5e8d 100644
--- a/doc/fsl.utils.callfsl.rst
+++ b/doc/fsl.utils.callfsl.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.callfsl module
-========================
+``fsl.utils.callfsl``
+=====================
.. automodule:: fsl.utils.callfsl
:members:
diff --git a/doc/fsl.utils.imcp.rst b/doc/fsl.utils.imcp.rst
index 4bee084c6..f34bdb160 100644
--- a/doc/fsl.utils.imcp.rst
+++ b/doc/fsl.utils.imcp.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.imcp module
-=====================
+``fsl.utils.imcp``
+==================
.. automodule:: fsl.utils.imcp
:members:
diff --git a/doc/fsl.utils.memoize.rst b/doc/fsl.utils.memoize.rst
index 42519daa6..af01e385b 100644
--- a/doc/fsl.utils.memoize.rst
+++ b/doc/fsl.utils.memoize.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.memoize module
-========================
+``fsl.utils.memoize``
+=====================
.. automodule:: fsl.utils.memoize
:members:
diff --git a/doc/fsl.utils.notifier.rst b/doc/fsl.utils.notifier.rst
index 32f231ea8..673856dd4 100644
--- a/doc/fsl.utils.notifier.rst
+++ b/doc/fsl.utils.notifier.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.notifier module
-=========================
+``fsl.utils.notifier``
+======================
.. automodule:: fsl.utils.notifier
:members:
diff --git a/doc/fsl.utils.path.rst b/doc/fsl.utils.path.rst
index 8b9ed0869..7a1441e6d 100644
--- a/doc/fsl.utils.path.rst
+++ b/doc/fsl.utils.path.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.path module
-=====================
+``fsl.utils.path``
+==================
.. automodule:: fsl.utils.path
:members:
diff --git a/doc/fsl.utils.platform.rst b/doc/fsl.utils.platform.rst
index 2ea7c014f..5ef87db18 100644
--- a/doc/fsl.utils.platform.rst
+++ b/doc/fsl.utils.platform.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.platform module
-=========================
+``fsl.utils.platform``
+======================
.. automodule:: fsl.utils.platform
:members:
diff --git a/doc/fsl.utils.rst b/doc/fsl.utils.rst
index a85be24a9..0784b9369 100644
--- a/doc/fsl.utils.rst
+++ b/doc/fsl.utils.rst
@@ -1,5 +1,5 @@
-fsl.utils package
-=================
+``fsl.utils``
+=============
.. toctree::
:hidden:
@@ -7,6 +7,7 @@ fsl.utils package
fsl.utils.async
fsl.utils.cache
fsl.utils.callfsl
+ fsl.utils.imcp
fsl.utils.memoize
fsl.utils.notifier
fsl.utils.path
diff --git a/doc/fsl.utils.settings.rst b/doc/fsl.utils.settings.rst
index 0330d1437..ff9cdad28 100644
--- a/doc/fsl.utils.settings.rst
+++ b/doc/fsl.utils.settings.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.settings module
-=========================
+``fsl.utils.settings``
+======================
.. automodule:: fsl.utils.settings
:members:
diff --git a/doc/fsl.utils.transform.rst b/doc/fsl.utils.transform.rst
index 5eb8ca60c..b21d270e9 100644
--- a/doc/fsl.utils.transform.rst
+++ b/doc/fsl.utils.transform.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.transform module
-==========================
+``fsl.utils.transform``
+=======================
.. automodule:: fsl.utils.transform
:members:
diff --git a/doc/fsl.utils.weakfuncref.rst b/doc/fsl.utils.weakfuncref.rst
index 1f2423e04..e1e3e9ab9 100644
--- a/doc/fsl.utils.weakfuncref.rst
+++ b/doc/fsl.utils.weakfuncref.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.utils.weakfuncref module
-============================
+``fsl.utils.weakfuncref``
+=========================
.. automodule:: fsl.utils.weakfuncref
:members:
diff --git a/doc/fsl.version.rst b/doc/fsl.version.rst
index c84977f55..bfd33bf7c 100644
--- a/doc/fsl.version.rst
+++ b/doc/fsl.version.rst
@@ -1,7 +1,5 @@
-:orphan:
-
-fsl.version module
-==================
+``fsl.version``
+===============
.. automodule:: fsl.version
:members:
--
GitLab