From 854a95ee68ba1ba6d0d87d566ba6ec06abc7b931 Mon Sep 17 00:00:00 2001
From: Steffen Hauf <haufs@max-exfl057.desy.de>
Date: Mon, 11 Jun 2018 21:16:13 +0200
Subject: [PATCH] More docs
---
docs/source/available_notebooks.rst | 2 +-
docs/source/how_it_works.rst | 2 +-
docs/source/index.rst | 2 ++
docs/source/installation.rst | 2 +-
docs/source/workflow.rst | 2 +-
5 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/docs/source/available_notebooks.rst b/docs/source/available_notebooks.rst
index 8123e3ed4..c2c883e17 100644
--- a/docs/source/available_notebooks.rst
+++ b/docs/source/available_notebooks.rst
@@ -1,4 +1,4 @@
-.. available_notebooks:
+.. _available_notebooks:
Available Notebooks
===================
diff --git a/docs/source/how_it_works.rst b/docs/source/how_it_works.rst
index 474990a87..0b125cddf 100644
--- a/docs/source/how_it_works.rst
+++ b/docs/source/how_it_works.rst
@@ -7,7 +7,7 @@ to expose Jupyter_ notebooks to a command line interface.
Additionally, it leverages the DESY/XFEL Maxwell cluster to run these jobs in parallel
via SLURM_.
-Here is a list of `available notebooks`_.
+Here is a list of `Available Notebooks`_.
.. _nbparameterise: https://github.com/takluyver/nbparameterise
.. _nbconver: https://github.com/jupyter/nbconvert
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0e52c8974..f8f42748b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -11,9 +11,11 @@ Contents:
.. toctree::
:maxdepth: 2
+ how_it_works
installation
configuration
workflow
+ availabe_notebooks
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index 91a2fece1..b329b891f 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -39,5 +39,5 @@ all prerequisites and this tool chain by running::
pip install -r requirements.txt .
-After installation, you should adjust the configuration_ and settings to
+After installation, you should adjust the :ref:`configuration` and settings to
match your environment.
\ No newline at end of file
diff --git a/docs/source/workflow.rst b/docs/source/workflow.rst
index 5a7191c21..07536255f 100644
--- a/docs/source/workflow.rst
+++ b/docs/source/workflow.rst
@@ -294,7 +294,7 @@ launch a concurrent job and generate a report out of notebook. If it fails to ru
normal Jupyter notebook environment, it will certainly fail in the tool chain environment.
Once you are satisfied with your current state of initial development, you can add it
-to the list of notebooks as mentioned in the configuration_ section.
+to the list of notebooks as mentioned in the :ref:`configuration` section.
Any changes you now make in the notebook will be automatically propagated to the command line.
Specifically, you should verify that all arguments are parsed correctly, e.g. by calling::
--
GitLab