Commit e63781ee authored by Paul McCarthy's avatar Paul McCarthy
Browse files

Adjusted documentation table-of-contents. Works nicer now.

parent 8bb2e120
......@@ -52,7 +52,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
master_doc = 'fsl'
# General information about the project.
project = u'fslpy'
......
fsl.data package
================
.. toctree::
:hidden:
fsl.data.atlases
fsl.data.constants
fsl.data.featimage
fsl.data.featresults
fsl.data.image
fsl.data.melodicimage
fsl.data.melodicresults
fsl.data.model
fsl.data.tensorimage
.. automodule:: fsl.data
:members:
:undoc-members:
......
fsl package
===========
.. toctree::
:hidden:
fsl.version
fsl.utils
fsl.data
.. automodule:: fsl
:members:
:undoc-members:
......
fsl.utils package
=================
.. toctree::
:hidden:
fsl.utils.async
fsl.utils.colourbarbitmap
fsl.utils.dialog
fsl.utils.imagepanel
fsl.utils.layout
fsl.utils.memoize
fsl.utils.notifier
fsl.utils.path
fsl.utils.platform
fsl.utils.runwindow
fsl.utils.settings
fsl.utils.status
fsl.utils.textbitmap
fsl.utils.transform
fsl.utils.typedict
fsl.utils.webpage
.. automodule:: fsl.utils
:members:
:undoc-members:
......
``fslpy``
=========
.. toctree::
:hidden:
:maxdepth: 2
fsl
fsl.data
fsl.utils
This is the ``fslpy`` API documentation.
Building the documentation
--------------------------
These pages have been built with the following commands (assuming that we
are starting in the ``fslpy`` root directory)::
cd apidoc
rm -rf html
sphinx-build . html
......@@ -6,19 +6,4 @@
#
"""This module contains various data types and associated I/O routines,
models, constants, and other data-like things used throughout ``fslpy``.
.. autosummary::
:nosignatures:
~fsl.data.image.Nifti1
~fsl.data.image.Image
~fsl.data.featimage.FEATImage
~fsl.data.melodicimage.MelodicImage
~fsl.data.tensorimage.TensorImage
~fsl.data.model.Model
~fsl.data.featresults
~fsl.data.melodicresults
~fsl.data.atlases
~fsl.data.constants
"""
......@@ -6,22 +6,4 @@
#
"""This module contains a collection of small utility modules for doing random
things.
.. autosummary::
:nosignatures:
~fsl.utils.settings
~fsl.utils.transform
~fsl.utils.typedict
~fsl.utils.layout
~fsl.utils.colourbarbitmap
~fsl.utils.textbitmap
~fsl.utils.dialog
~fsl.utils.runwindow
~fsl.utils.webpage
~fsl.utils.status
~fsl.utils.memoize
~fsl.utils.path
~fsl.utils.async
~fsl.utils.notifier
"""
Markdown is supported
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