From 52907a3eebf6c14e99233f978fd8c9a11eb4493e Mon Sep 17 00:00:00 2001 From: Paul McCarthy <pauldmccarthy@gmail.com> Date: Mon, 7 Oct 2019 11:47:00 +0100 Subject: [PATCH] DOC: More info on landing page --- doc/index.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index dd49636cd..2ff98d800 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,7 +4,23 @@ The ``fslpy`` package is a collection of utilities and data abstractions used -by |fsleyes_apidoc|_. +within `FSL <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki>`_ and by +|fsleyes_apidoc|_. + + +The top-level Python package for ``fslpy`` is called ``fsl``. It is broadly +split into the following sub-packages: + + +.. autosummary:: + + fsl.data + fsl.utils + fsl.scripts + fsl.transform + fsl.version + fsl.wrappers + .. toctree:: :hidden: -- GitLab