DOC: Rework doc landing page, adjust for fsl.scripts change

doc/fsl.scripts.rst

@@ -20,7 +20,11 @@
    fsl.scripts.Text2Vest
    fsl.scripts.Vest2Text
 
-.. automodule:: fsl.scripts
-    :members:
-    :undoc-members:
-    :show-inheritance:
+
+The ``fsl.scripts`` package contains all of the executable scripts provided by
+``fslpy``, and other python-based FSL packages.
+
+
+The ``fsl.scripts`` package is a `native namespace package
+<https://packaging.python.org/guides/packaging-namespace-packages/>`_, which
+means that it can be used by other Python libraries.

doc/index.rst

@@ -11,16 +11,27 @@ within `FSL <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki>`_ and by
 The top-level Python package for ``fslpy`` is called :mod:`fsl`.  It is
 broadly split into the following sub-packages:
 
-
-.. autosummary::
-
-   fsl.data
-   fsl.utils
-   fsl.scripts
-   fsl.transform
-   fsl.version
-   fsl.wrappers
-
++----------------------+-----------------------------------------------------+
+| :mod:`fsl.data`      | contains data abstractions and I/O routines for a   |
+|                      | range of FSL and neuroimaging file types. Most I/O  |
+|                      | routines use `nibabel <https://nipy.org/nibabel/>`_ |
+|                      | extensively.                                        |
++----------------------+-----------------------------------------------------+
+| :mod:`fsl.utils`     | contains a range of miscellaneous utilities,        |
+|                      | including :mod:`fsl.utils.path`,                    |
+|                      | :mod:`fsl.utils.run`, and :mod:`fsl.utils.bids`     |
++----------------------+-----------------------------------------------------+
+| :mod:`fsl.scripts`   | contains a range of scripts which are installed as  |
+|                      | FSL commands.                                       |
++----------------------+-----------------------------------------------------+
+| :mod:`fsl.transform` | contains functions and classes for working with     |
+|                      | FSL-style linear and non-linear transformations.    |
++----------------------+-----------------------------------------------------+
+| :mod:`fsl.version`   | simply contains the ``fslpy`` version number.       |
++----------------------+-----------------------------------------------------+
+| :mod:`fsl.wrappers`  | contains Python functions which can be used to      |
+|                      | invoke FSL commands.                                |
++----------------------+-----------------------------------------------------+
 
 The :mod:`fsl` package provides the top-level Python package namespace for
 ``fslpy``, and for other FSL python libaries. It is a `native namespace
@@ -39,5 +50,11 @@ package namespace.
    :hidden:
 
    self
+   fsl.data
+   fsl.scripts
+   fsl.transform
+   fsl.utils
+   fsl.wrappers
+   fsl.version
    contributing
    changelog