Skip to content

Commit 1d3c36c

Browse files
authored
Update docs to fix section overviews (#2883)
1 parent 8b1bd2e commit 1d3c36c

File tree

4 files changed

+289
-54
lines changed

4 files changed

+289
-54
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@
172172

173173
# Custom sidebar templates, maps document names to template names.
174174
html_sidebars = {
175+
"getting_started": [],
175176
"migration_guide": [], # No sidebar migration
176177
}
177178

docs/getting_started.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,4 @@ Enjoy modelling with Mesa, and feel free to reach out!
5555

5656

5757

58-
```{toctree}
59-
:hidden: true
60-
:maxdepth: 7
61-
62-
Overview <overview>
63-
Creating Your First Model <tutorials/0_first_model>
64-
Adding Space <tutorials/1_adding_space>
65-
Collecting Data <tutorials/2_collecting_data>
66-
AgentSet <tutorials/3_agentset>
67-
Basic Visualization <tutorials/4_visualization_basic>
68-
Dynamic Agent Visualization <tutorials/5_visualization_dynamic_agents>
69-
Visualisation using SpaceRenderer <tutorials/6_visualization_rendering_with_space_renderer>
70-
Property Layer Visualization <tutorials/7_visualization_propertylayer_visualization>
71-
Custom Visualization Components <tutorials/8_visualization_custom>
72-
Parameter Sweeps <tutorials/9_batch_run>
73-
Comparing Scenarios <tutorials/10_comparing_scenarios>
74-
Best Practices <best-practices>
75-
76-
77-
```
58+

docs/overview.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -309,10 +309,12 @@ Collecting Data <tutorials/2_collecting_data>
309309
AgentSet <tutorials/3_agentset>
310310
Basic Visualization <tutorials/4_visualization_basic>
311311
Dynamic Agent Visualization <tutorials/5_visualization_dynamic_agents>
312-
Custom Visualization Components <tutorials/6_visualization_custom>
313-
Parameter Sweeps <tutorials/7_batch_run>
314-
Comparing Scenarios <tutorials/8_comparing_scenarios>
312+
Visualisation using SpaceRenderer <tutorials/6_visualization_rendering_with_space_renderer>
313+
Property Layer Visualization <tutorials/7_visualization_propertylayer_visualization>
314+
Custom Visualization Components <tutorials/8_visualization_custom>
315+
Parameter Sweeps <tutorials/9_batch_run>
316+
Comparing Scenarios <tutorials/10_comparing_scenarios>
315317
Best Practices <best-practices>
316318
317319
318-
```
320+
```

0 commit comments

Comments
 (0)