Update docs

Deltares-research · Jan 17, 2025 · 51e0aa1 · 51e0aa1
1 parent 823908d
commit 51e0aa1
Show file tree

Hide file tree

Showing 7 changed files with 2 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -4,5 +4,3 @@
 
 - [Developer manual](documentation/develop/index.rst)
 - [User manual](documentation/use/index.rst)
-
-<img src="documentation/use/generator.png"/>
diff --git a/documentation/develop/environment.rst b/documentation/develop/environment.rst
@@ -55,7 +55,7 @@ In commands:
    # Note: commit .pre-commit-config.yaml if any hooks actually got updated
    pre-commit autoupdate
 
-   source/script/ap_pathway_generator.py --help
+   source/script/ap_plot_pathway_map.py --help
 
 
 The project contains code for generating :ref:`targets <sec-cmake>`, like documentation and the

diff --git a/documentation/use/CMakeLists.txt b/documentation/use/CMakeLists.txt
@@ -1,6 +1,4 @@
 foreach(name IN ITEMS
-        generator.png
-        generator.rst
         get_started.rst
         import_export.rst
         index.rst

diff --git a/documentation/use/generator.png b/documentation/use/generator.png
diff --git a/documentation/use/generator.rst b/documentation/use/generator.rst
diff --git a/documentation/use/get_started.rst b/documentation/use/get_started.rst
@@ -2,12 +2,7 @@ Get started
 ===========
 
 Here, we assume that you want to get started using the ``adaptation_pathways`` Python package
-distributed as a so-called Python Wheel. There are other ways the package can be distributed,
-for example as a portable application, containing the Pathway Generator GUI application and all
-its dependencies. Installing that package is simply a matter of unzipping the file. The advantage
-is the simplicity to get the Pathway Generator application up and running, but to be able to
-use all functionality from the ``adaptation_pathways`` package, the Wheel should be installed
-as described on the rest of this page.
+distributed as a so-called Python Wheel.
 
 The ``adaptation_pathways`` Python package can be used by performing these steps in turn:
 
@@ -79,7 +74,6 @@ Once the software is installed correctly, the following should work:
 
    # Use an installed script
    ap_plot_pathway_map --help
-   ap_pathway_generator --help
 
    # Use the package
    python3 -c "import adaptation_pathways as ap; print(ap.__version__)"

diff --git a/documentation/use/index.rst b/documentation/use/index.rst
@@ -7,7 +7,3 @@ Use
    Get started <get_started>
    Import / export <import_export>
    Plotting pathways <plot>
-   Pathway generator <generator>
-
-
-.. image:: generator.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,5 +4,3 @@

		- [Developer manual](documentation/develop/index.rst)
		- [User manual](documentation/use/index.rst)

		<img src="documentation/use/generator.png"/>