Skip to content

Commit

Permalink
add docu index
Browse files Browse the repository at this point in the history
  • Loading branch information
dodu94 committed Jan 31, 2025
1 parent 9a381b2 commit e346ac0
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/source/documentation/contributors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand Down
11 changes: 10 additions & 1 deletion docs/source/documentation/docu_idx.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
#############
Documentation
#############
#############

.. toctree::
:maxdepth: 2
:caption: Contents:

benchmarks
contributors
LICENSE
publications
4 changes: 2 additions & 2 deletions docs/source/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<JADE_root> 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_root> 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``
Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/usage_idx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Install and Configure
:caption: Installation and Configuration

./installation
./user_configuraion
./user_configuration
./folders

JADE execution
Expand Down

0 comments on commit e346ac0

Please sign in to comment.