diff --git a/doc/fsl.rst b/doc/fsl.rst deleted file mode 100644 index 7f7f231bd27ae1d641bbcd8d1509e6adc3d4114d..0000000000000000000000000000000000000000 --- a/doc/fsl.rst +++ /dev/null @@ -1,24 +0,0 @@ -``fsl`` -======= - -.. toctree:: - :hidden: - - fsl.data - fsl.scripts - fsl.utils - fsl.transform - fsl.version - fsl.wrappers - - -The :mod:`fsl` package provides the top-level Python package namespace for -``fslpy``, and for other FSL python libaries. It is a `native namespace -package <https://packaging.python.org/guides/packaging-namespace-packages/>`_, -which means that there is no ``fsl/__init__.py`` file. - - -Other libraries can use the ``fsl`` package namepace simply by also omitting a -``fsl/__init__.py`` file, and by ensuring that there are no naming conflicts -with any sub-packages of ``fslpy`` or any other projects which use the ``fsl`` -package namespace. diff --git a/doc/index.rst b/doc/index.rst index 2ff98d800e9959b210b874571db3dd7baef8c230..5603ff0bbc4ab4bb4be2b13d3c44fbb8332a9b44 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,8 +8,8 @@ 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: +The top-level Python package for ``fslpy`` is called :mod:`fsl`. It is +broadly split into the following sub-packages: .. autosummary:: @@ -22,10 +22,22 @@ split into the following sub-packages: fsl.wrappers +The :mod:`fsl` package provides the top-level Python package namespace for +``fslpy``, and for other FSL python libaries. It is a `native namespace +package <https://packaging.python.org/guides/packaging-namespace-packages/>`_, +which means that there is no ``fsl/__init__.py`` file. + + +Other libraries can use the ``fsl`` package namepace simply by also omitting a +``fsl/__init__.py`` file, and by ensuring that there are no naming conflicts +with any sub-packages of ``fslpy`` or any other projects which use the ``fsl`` +package namespace. + + + .. toctree:: :hidden: self - fsl contributing changelog