Commit 4c4357ae authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

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

parent d0737673
...@@ -20,7 +20,11 @@ ...@@ -20,7 +20,11 @@
fsl.scripts.Text2Vest fsl.scripts.Text2Vest
fsl.scripts.Vest2Text fsl.scripts.Vest2Text
.. automodule:: fsl.scripts
:members: The ``fsl.scripts`` package contains all of the executable scripts provided by
:undoc-members: ``fslpy``, and other python-based FSL packages.
:show-inheritance:
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.
...@@ -11,16 +11,27 @@ within `FSL <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki>`_ and by ...@@ -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 The top-level Python package for ``fslpy`` is called :mod:`fsl`. It is
broadly split into the following sub-packages: broadly split into the following sub-packages:
+----------------------+-----------------------------------------------------+
.. autosummary:: | :mod:`fsl.data` | contains data abstractions and I/O routines for a |
| | range of FSL and neuroimaging file types. Most I/O |
fsl.data | | routines use `nibabel <https://nipy.org/nibabel/>`_ |
fsl.utils | | extensively. |
fsl.scripts +----------------------+-----------------------------------------------------+
fsl.transform | :mod:`fsl.utils` | contains a range of miscellaneous utilities, |
fsl.version | | including :mod:`fsl.utils.path`, |
fsl.wrappers | | :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 The :mod:`fsl` package provides the top-level Python package namespace for
``fslpy``, and for other FSL python libaries. It is a `native namespace ``fslpy``, and for other FSL python libaries. It is a `native namespace
...@@ -39,5 +50,11 @@ package namespace. ...@@ -39,5 +50,11 @@ package namespace.
:hidden: :hidden:
self self
fsl.data
fsl.scripts
fsl.transform
fsl.utils
fsl.wrappers
fsl.version
contributing contributing
changelog changelog
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment