Skip to content
Snippets Groups Projects
Commit 854a95ee authored by Steffen Hauf's avatar Steffen Hauf
Browse files

More docs

parent cfcdd5a6
No related branches found
No related tags found
1 merge request!5Clean
.. available_notebooks:
.. _available_notebooks:
Available Notebooks
===================
......
......@@ -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
......
......@@ -11,9 +11,11 @@ Contents:
.. toctree::
:maxdepth: 2
how_it_works
installation
configuration
workflow
availabe_notebooks
......
......@@ -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
......@@ -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::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment