diff --git a/doc/conf.py b/doc/conf.py index e257faab986c5a5b336cfe3bc8ec127a3a0bac5d..7c1e34c5c977f8a5424a715a1ecab35996944932 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -51,13 +51,19 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'fsl' +master_doc = 'index' # General information about the project. project = u'fslpy' copyright = u'{}, Paul McCarthy, FMRIB Centre, University of Oxford'.format( date.year) +# Links to other things +rst_epilog = """ +.. _fsleyes_apidoc: http://users.fmrib.ox.ac.uk/~paulmc/fsleyes_apidoc/index.html +""" + + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..91903fe8cbd4da111b9392a52e5979fdbecbf386 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,13 @@ + +``fslpy`` +========= + + +The ``fslpy`` package is a collection of utilities and data abstractions used +by `FSLeyes <fsleyes_apidoc>`_. + +.. toctree:: + :hidden: + + self + fsl