Reorganize pages and small edits.

Moves the pelicun framework in the user guide. A few minor editorial updates. More are still needed.
ioannis-vm · Oct 29, 2024 · 382c776 · 382c776
1 parent 47350db
commit 382c776
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 85 deletions.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -24,19 +24,13 @@ Utilized in both academia and industry, it supports cutting-edge natural hazards
    about/acknowledgments.rst
    release_notes/index.rst
 
-.. toctree::
-   :caption: The Pelicun Framework
-   :maxdepth: 1
-   :numbered: 4
-
-   pelicun_framework/pelicun_framework.rst
-
 .. toctree::
    :caption: User Guide
    :maxdepth: 1
    :numbered: 4
 
    user_guide/install.rst
+   user_guide/pelicun_framework.rst
    user_guide/feature_overview.rst
    user_guide/damage_and_loss_library.rst
    user_guide/bug_reports_and_feature_requests.rst

diff --git a/...n_framework/figures/MainWorkflowComps.png → .../user_guide/figures/MainWorkflowComps.png b/...n_framework/figures/MainWorkflowComps.png → .../user_guide/figures/MainWorkflowComps.png
diff --git a/.../pelicun_framework/figures/ModelTypes.png → doc/source/user_guide/figures/ModelTypes.png b/.../pelicun_framework/figures/ModelTypes.png → doc/source/user_guide/figures/ModelTypes.png
diff --git a/...un_framework/figures/PerfAssWorkflows.png → ...e/user_guide/figures/PerfAssWorkflows.png b/...un_framework/figures/PerfAssWorkflows.png → ...e/user_guide/figures/PerfAssWorkflows.png
diff --git a/doc/source/user_guide/install.rst b/doc/source/user_guide/install.rst
@@ -8,6 +8,7 @@ Join our growing community of users and developers dedicated to advancing risk e
 Getting started
 ---------------
 
+===============
 `Pelicun <https://pypi.org/project/pelicun/>`_ is available on the Python Package Index (PyPI) and should work out-of-the-box in all major platforms.
 
 .. tip::

diff --git a/...e/pelicun_framework/pelicun_framework.rst → doc/source/user_guide/pelicun_framework.rst b/...e/pelicun_framework/pelicun_framework.rst → doc/source/user_guide/pelicun_framework.rst