Update to the toolbox docs

Author: BRgit7

docs/source/user_guide/api_toolbox.rst

@@ -13,15 +13,24 @@ Tools will sit under the following categories: Results Analysis, Model Build, Mo
 
 These tools act as standalone scripts. To run them, please read the available documentation for each tool.
 
-.. _fmapi_toolbox_cli:
+.. _fmapi_toolbox:
 
-fmapi-toolbox cli
------------------
+fmapi-toolbox
+-------------
 
-.. _how_to_run_a_tool:
+A tool to use in the command line to interact with all the API toolbox scripts.
+
+You can use these command line arguements:
+
+- *-l* or *-list* : list all toolbox scripts installed
+- *-ld* or *-list-detailed* : list all toolbox scripts installed including usage
+- *-r* or *-register* : register a new tool to the fmapi-toolbox
+
+.. _run_a_tool:
+
+Run a tool
+----------
 
-How to run a tool
------------------
 Tools can be run from the command line or from code: 
 
 .. note::   
@@ -43,33 +52,48 @@ Tools can be run from the command line or from code:
         name="model_name",
     )
 
-.. _how_edit_existing_tool:
+.. _edit_existing_tool:
+
+Edit an existing tool
+---------------------
 
-How to edit an existing tool
-----------------------------
+You can edit previously existing tools for the Flood Modeller API.
 
-.. _how_to_add_a_new_tool:
+Go to the scripts folder and select the tool you want to edit, then change what you want to.
 
-How to add a new tool
----------------------
+.. _add_a_new_tool:
+
+Add a new tool
+--------------
 
 You can develop your own tools to integrate with the Flood Modeller Python API.
 
 There are a few conventions you need to follow to do this:
 
-- Add a python file to one of the directories in the toolbox
-- Within the file, define the tool as single function
+- Add a python file to one of the directories in the toolbox, depending on the category of the tool
+- Within the file, define the tool as a single function (add a definition file)
 - Within the same file, create a child class of FMTool, passing in the tool name and description, funciton to be run and the function parameters
+- Register the file as a script 
+
+See the *example_tool.py* script in the toolbox for an example of how to do this.
+
+.. _add_new_execution_method:
 
-See the *example_tool.py* script for an example of how to do this.
+Add a new execution method
+--------------------------
 
-**Create the code**
+You can add command-line execution for a tool by having its *.py* and *.bat* scripts in the *scripts* folder.
 
-**Add a definition file**
+.. code:: python
 
-**Register it as a script**
+    example.py
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    from floodmodeller_api.toolbox import Example
+    Example().run_from_command_line()
 
-.. _how_to_add_new_execution_method:
+.. code:: console
 
-How to add a new execution method
----------------------------------
+    example.bat
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    @echo off
+    python "%~dp0\example.py" %*

docs/source/user_guide/list_of_api_tools.rst

@@ -38,4 +38,14 @@ Or you can use it from your code:
         tcf_path="path/to/tcf.tcf",
         folder="path/to/model",
         name="model_name",
-    )
+    )
+
+.. _raise_section_bed_levels:
+
+raise_section_bed_levels
+------------------------
+
+.. _interactive_flow_graph:
+
+interactive_flow_graph
+----------------------