Skip to content

Commit c8de9d0

Browse files
committed
Small update on docs
1 parent 2595ce3 commit c8de9d0

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

5_steps_to_n_body_simulation/step1.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
## How to use this tutorial?
2+
The source code for the python scripts and the markdown files are available on
3+
4+
* https://github.com/alvinng4/grav_sim/tree/main/5_steps_to_n_body_simulation
5+
6+
but I strongly recommend reading this tutorial on our website:
7+
8+
* https://alvinng4.github.io/grav_sim/5_steps_to_n_body_simulation/
9+
10+
Snippets of the code will be shown as we progress, but you don't have to copy them one by one as the full code is always available at the end of each step. However,
11+
I do recommend you to translate it into your own code in order to have a better understanding.
12+
113
# Step 1: Initial setup
214

315
Welcome to the first step of 5 steps to N-body simulation!
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: grav_sim.utils
2+
options:
3+
docstring_style: numpy

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ nav:
2828
- docs/documentations/PythonAPI/plotting.md
2929
- docs/documentations/PythonAPI/System.md
3030
- docs/documentations/PythonAPI/Simulator.md
31+
- docs/documentations/PythonAPI/utils.md
3132
- C API:
3233
- docs/documentations/CAPI/grav_sim.md
3334
- Examples:

0 commit comments

Comments
 (0)