From e346ac0a62b0779b400a7fed13d4a9387c5dd264 Mon Sep 17 00:00:00 2001 From: Davide Laghi Date: Fri, 31 Jan 2025 22:11:09 +0100 Subject: [PATCH] add docu index --- docs/source/documentation/contributors.rst | 6 +++--- docs/source/documentation/docu_idx.rst | 11 ++++++++++- docs/source/usage/installation.rst | 4 ++-- docs/source/usage/usage_idx.rst | 2 +- 4 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/source/documentation/contributors.rst b/docs/source/documentation/contributors.rst index 29013970..0a854e3b 100644 --- a/docs/source/documentation/contributors.rst +++ b/docs/source/documentation/contributors.rst @@ -15,11 +15,11 @@ This activity was partially funded by Fusion For Energy under F4E-OPE-1128 contr .. image:: /img/contrib/nier.png :width: 300 -.. image:: source/img/contrib/unibo.jpg +.. image:: /img/contrib/unibo.jpg :width: 300 -.. image:: ../img/contrib/f4e.jpg +.. image:: /img/contrib/f4e.jpg :width: 300 -.. image:: ../img/contrib/UKAEA.png +.. image:: /img/contrib/UKAEA.png :width: 150 **JADE contributors:** diff --git a/docs/source/documentation/docu_idx.rst b/docs/source/documentation/docu_idx.rst index 456889c5..898b1ccb 100644 --- a/docs/source/documentation/docu_idx.rst +++ b/docs/source/documentation/docu_idx.rst @@ -1,3 +1,12 @@ ############# Documentation -############# \ No newline at end of file +############# + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + benchmarks + contributors + LICENSE + publications \ No newline at end of file diff --git a/docs/source/usage/installation.rst b/docs/source/usage/installation.rst index 697af85f..5cc1ec04 100644 --- a/docs/source/usage/installation.rst +++ b/docs/source/usage/installation.rst @@ -60,8 +60,8 @@ Create a jade folder tree JADE has now been installed as a command line tool. To complete the installation, create a new folder where you prefer. This is going to to be the - folder. You can have as many JADE tree as you prefer in your machine. - Now Move into the root directory and run the following command: + folder. You can have as many JADE tree as you prefer in your machine. +Now Move into the root directory and run the following command: | ``jade`` diff --git a/docs/source/usage/usage_idx.rst b/docs/source/usage/usage_idx.rst index 5d747ca6..be73b253 100644 --- a/docs/source/usage/usage_idx.rst +++ b/docs/source/usage/usage_idx.rst @@ -9,7 +9,7 @@ Install and Configure :caption: Installation and Configuration ./installation - ./user_configuraion + ./user_configuration ./folders JADE execution