split examples folder

AequilibraE · Dec 12, 2024 · 5ea6c05 · 5ea6c05
1 parent f2a003f
commit 5ea6c05
Show file tree

Hide file tree

Showing 42 changed files with 30 additions and 40 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -64,7 +64,7 @@ jobs:
 
     - name: Build documentation
       run: |
-        jupyter nbconvert --to rst docs/source/useful_information/validation_benchmarking/IPF_benchmark.ipynb
+        jupyter nbconvert --to rst docs/source/traffic_assignment/validation_benchmarking/IPF_benchmark.ipynb
         sphinx-build -M latexpdf docs/source docs/source/_static -D plot_gallery=False
         sphinx-build -D plot_gallery=False -b html docs/source docs/build
         python -m zipfile -c AequilibraE.zip docs/build

diff --git a/.gitignore b/.gitignore
@@ -2,11 +2,10 @@
 _build
 _static
 _templates
-docs/source/sg_execution_times.rst
-docs/source/_auto_examples
-docs/source/useful_links/_generated
-docs/source/aequilibrae_project/project_database/data_model
-docs/source/aequilibrae_project/transit_database/data_model
+sg_execution_times.rst
+_auto_examples
+_generated
+data_model
 
 # User-specific stuff:
 .idea/**/workspace.xml

diff --git a/docs/source/aequilibrae_project/examples/index.rst b/docs/source/aequilibrae_project/examples/index.rst
@@ -0,0 +1,2 @@
+AequilibraE Project
+-------------------
diff --git a/.../other_applications/plot_check_logging.py → ...ae_project/examples/plot_check_logging.py b/.../other_applications/plot_check_logging.py → ...ae_project/examples/plot_check_logging.py
diff --git a/..._applications/plot_logging_to_terminal.py → ...ject/examples/plot_logging_to_terminal.py b/..._applications/plot_logging_to_terminal.py → ...ject/examples/plot_logging_to_terminal.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -72,21 +72,20 @@
 
 # Change plot_gallery to True to start building examples again
 sphinx_gallery_conf = {
-    "examples_dirs": ["examples"],  # path to your example scripts
-    "gallery_dirs": ["_auto_examples"],  # path to where to save gallery generated output
+    "examples_dirs": ["aequilibrae_project/examples",
+                      "network_manipulation/examples",
+                      "project_components/examples",
+                      "route_choice/examples",
+                      "traffic_assignment/examples",
+                      "transit_assignment/examples"],  # path to your example scripts
+    "gallery_dirs": ["aequilibrae_project/_auto_examples",
+                      "network_manipulation/_auto_examples",
+                      "project_components/_auto_examples",
+                      "route_choice/_auto_examples",
+                      "traffic_assignment/_auto_examples",
+                      "transit_assignment/_auto_examples"],  # path to where to save gallery generated output
     "capture_repr": ("_repr_html_", "__repr__"),
     "remove_config_comments": True,
-    "subsection_order": ExplicitOrder(
-        [
-            "examples/creating_models",
-            "examples/editing_networks",
-            "examples/skimming",
-            "examples/assignment_workflows",
-            "examples/aequilibrae_without_a_model",
-            "examples/visualization",
-            "examples/other_applications",
-        ]
-    ),
     "plot_gallery": True,
 }
 

diff --git a/docs/source/examples/aequilibrae_without_a_model/readme.rst b/docs/source/examples/aequilibrae_without_a_model/readme.rst
diff --git a/docs/source/examples/assignment_workflows/readme.rst b/docs/source/examples/assignment_workflows/readme.rst
diff --git a/docs/source/examples/creating_models/readme.rst b/docs/source/examples/creating_models/readme.rst
diff --git a/docs/source/examples/editing_networks/readme.rst b/docs/source/examples/editing_networks/readme.rst
diff --git a/docs/source/examples/other_applications/readme.rst b/docs/source/examples/other_applications/readme.rst
diff --git a/docs/source/examples/readme.rst b/docs/source/examples/readme.rst
diff --git a/docs/source/examples/skimming/readme.rst b/docs/source/examples/skimming/readme.rst
diff --git a/docs/source/examples/visualization/readme.rst b/docs/source/examples/visualization/readme.rst
diff --git a/docs/source/network_manipulation/examples/index.rst b/docs/source/network_manipulation/examples/index.rst
@@ -0,0 +1,2 @@
+Network Manipulation
+--------------------
diff --git a/.../creating_models/plot_create_from_gmns.py → ...ulation/examples/plot_create_from_gmns.py b/.../creating_models/plot_create_from_gmns.py → ...ulation/examples/plot_create_from_gmns.py
diff --git a/...creating_models/plot_create_from_layer.py → ...lation/examples/plot_create_from_layer.py b/...creating_models/plot_create_from_layer.py → ...lation/examples/plot_create_from_layer.py
diff --git a/...s/creating_models/plot_create_from_osm.py → ...pulation/examples/plot_create_from_osm.py b/...s/creating_models/plot_create_from_osm.py → ...pulation/examples/plot_create_from_osm.py
diff --git a/...ples/visualization/plot_delaunay_lines.py → ...ipulation/examples/plot_delaunay_lines.py b/...ples/visualization/plot_delaunay_lines.py → ...ipulation/examples/plot_delaunay_lines.py
diff --git a/...ce/examples/visualization/plot_display.py → ...ork_manipulation/examples/plot_display.py b/...ce/examples/visualization/plot_display.py → ...ork_manipulation/examples/plot_display.py
diff --git a/...other_applications/plot_export_to_gmns.py → ...ipulation/examples/plot_export_to_gmns.py b/...other_applications/plot_export_to_gmns.py → ...ipulation/examples/plot_export_to_gmns.py
diff --git a/...er_applications/plot_find_disconnected.py → ...lation/examples/plot_find_disconnected.py b/...er_applications/plot_find_disconnected.py → ...lation/examples/plot_find_disconnected.py
diff --git a/...ng_networks/plot_moving_link_extremity.py → ...on/examples/plot_moving_link_extremity.py b/...ng_networks/plot_moving_link_extremity.py → ...on/examples/plot_moving_link_extremity.py
diff --git a/...les/editing_networks/plot_moving_nodes.py → ...anipulation/examples/plot_moving_nodes.py b/...les/editing_networks/plot_moving_nodes.py → ...anipulation/examples/plot_moving_nodes.py
diff --git a/...xamples/skimming/plot_path_computation.py → ...ulation/examples/plot_path_computation.py b/...xamples/skimming/plot_path_computation.py → ...ulation/examples/plot_path_computation.py
diff --git a/...source/examples/skimming/plot_skimming.py → ...rk_manipulation/examples/plot_skimming.py b/...source/examples/skimming/plot_skimming.py → ...rk_manipulation/examples/plot_skimming.py
diff --git a/...s/editing_networks/plot_splitting_link.py → ...ipulation/examples/plot_splitting_link.py b/...s/editing_networks/plot_splitting_link.py → ...ipulation/examples/plot_splitting_link.py
diff --git a/docs/source/project_components/examples/index.rst b/docs/source/project_components/examples/index.rst
@@ -0,0 +1,2 @@
+Project Components
+------------------
diff --git a/...les/creating_models/plot_create_zoning.py → ...components/examples/plot_create_zoning.py b/...les/creating_models/plot_create_zoning.py → ...components/examples/plot_create_zoning.py
diff --git a/...mples/creating_models/plot_import_gtfs.py → ...t_components/examples/plot_import_gtfs.py b/...mples/creating_models/plot_import_gtfs.py → ...t_components/examples/plot_import_gtfs.py
diff --git a/docs/source/route_choice/examples/index.rst b/docs/source/route_choice/examples/index.rst
@@ -0,0 +1,2 @@
+Route Choice
+------------
diff --git a/...ent_workflows/plot_route_choice_basics.py → ...oice/examples/plot_route_choice_basics.py b/...ent_workflows/plot_route_choice_basics.py → ...oice/examples/plot_route_choice_basics.py
diff --git a/...gnment_workflows/plot_route_choice_set.py → ..._choice/examples/plot_route_choice_set.py b/...gnment_workflows/plot_route_choice_set.py → ..._choice/examples/plot_route_choice_set.py
diff --git a/...gnment_workflows/plot_subarea_analysis.py → ..._choice/examples/plot_subarea_analysis.py b/...gnment_workflows/plot_subarea_analysis.py → ..._choice/examples/plot_subarea_analysis.py
diff --git a/docs/source/traffic_assignment/examples/index.rst b/docs/source/traffic_assignment/examples/index.rst
@@ -0,0 +1,2 @@
+Traffic Assignment
+------------------
diff --git a/..._a_model/plot_assignment_without_model.py → ...examples/plot_assignment_without_model.py b/..._a_model/plot_assignment_without_model.py → ...examples/plot_assignment_without_model.py
diff --git a/.../assignment_workflows/plot_forecasting.py → ...c_assignment/examples/plot_forecasting.py b/.../assignment_workflows/plot_forecasting.py → ...c_assignment/examples/plot_forecasting.py
diff --git a/...without_a_model/plot_ipf_without_model.py → ...gnment/examples/plot_ipf_without_model.py b/...without_a_model/plot_ipf_without_model.py → ...gnment/examples/plot_ipf_without_model.py
diff --git a/...gnment_workflows/select_link_analysis.omx → ...ignment/examples/select_link_analysis.omx b/...gnment_workflows/select_link_analysis.omx → ...ignment/examples/select_link_analysis.omx
diff --git a/docs/source/transit_assignment/examples/index.rst b/docs/source/transit_assignment/examples/index.rst
@@ -0,0 +1,2 @@
+Transit Assignment
+------------------
diff --git a/...rkflows/plot_public_transit_assignment.py → ...xamples/plot_public_transit_assignment.py b/...rkflows/plot_public_transit_assignment.py → ...xamples/plot_public_transit_assignment.py
diff --git a/docs/website/check_documentation_versions.py b/docs/website/check_documentation_versions.py
@@ -12,7 +12,7 @@
 
 # We check if the reference to all existing versions were added by checking
 # that the current version is referenced
-with open(os.path.join(npth, "docs/source/useful_information/version_history.rst"), mode="r") as f:
+with open(os.path.join(npth, "docs/source/useful_links/version_history.rst"), mode="r") as f:
     txt = f.read()
 
 print(f"python/V.{release_version}")