From 45034d41f731b4d3d64c84b3d9d61deff8c1ace1 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Mon, 7 Nov 2016 10:59:57 +0000
Subject: [PATCH] Root doc page is now index.html
---
doc/conf.py | 8 +++++++-
doc/index.rst | 13 +++++++++++++
2 files changed, 20 insertions(+), 1 deletion(-)
create mode 100644 doc/index.rst
diff --git a/doc/conf.py b/doc/conf.py
index e257faab9..7c1e34c5c 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 000000000..91903fe8c
--- /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
--
GitLab