From 590175d29f7ce62e6eb8f257c1c5951dc702ff68 Mon Sep 17 00:00:00 2001 From: Tord <48350530+tordnat@users.noreply.github.com> Date: Tue, 31 Dec 2024 12:17:29 +0100 Subject: [PATCH] Issuse 33: page restructure (#34) * Add: Lecture notes and assignments chapter * Fix typos --- docs/{ => assignments}/assignment-1.rst | 2 +- docs/assignments/index.rst | 9 +++++ docs/figures/week-0.svg | 21 ++++++++++++ docs/index.rst | 33 ++++++++++--------- docs/installation.rst | 4 +-- ...ter-notebooks.rst => jupyter-notebook.rst} | 4 +-- docs/lecture-notes/index.rst | 8 +++++ docs/lecture-notes/week-0.rst | 6 ++++ 8 files changed, 66 insertions(+), 21 deletions(-) rename docs/{ => assignments}/assignment-1.rst (96%) create mode 100644 docs/assignments/index.rst create mode 100644 docs/figures/week-0.svg rename docs/{jupyter-notebooks.rst => jupyter-notebook.rst} (98%) create mode 100644 docs/lecture-notes/index.rst create mode 100644 docs/lecture-notes/week-0.rst diff --git a/docs/assignment-1.rst b/docs/assignments/assignment-1.rst similarity index 96% rename from docs/assignment-1.rst rename to docs/assignments/assignment-1.rst index 66e80a6..ffbe051 100644 --- a/docs/assignment-1.rst +++ b/docs/assignments/assignment-1.rst @@ -4,7 +4,7 @@ Assignment 1 We consider here a mass-damper-spring system as shown in the figure below. -.. figure:: figures/mass_damper_spring.svg +.. figure:: ../figures/mass_damper_spring.svg :align: center Schematic of the mass-damper-spring system. diff --git a/docs/assignments/index.rst b/docs/assignments/index.rst new file mode 100644 index 0000000..44d7915 --- /dev/null +++ b/docs/assignments/index.rst @@ -0,0 +1,9 @@ +============ +Assignments +============ + + +.. toctree:: + :maxdepth: 1 + + assignment-1 diff --git a/docs/figures/week-0.svg b/docs/figures/week-0.svg new file mode 100644 index 0000000..a9ef617 --- /dev/null +++ b/docs/figures/week-0.svg @@ -0,0 +1,21 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index db2c438..14c6afb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,22 +7,23 @@ Welcome to Modelling and Simulation! .. toctree:: - :maxdepth: 1 - :caption: Contents: - - installation - jupyter-notebooks - sympy-and-cas - numerical-methods-for-odes - numerical-instability - simulation - rotations - reference-frames - assignment-1 - quaternions - sympy-live - notation - bibliography + :maxdepth: 1 + :caption: Contents: + + installation + jupyter-notebook + sympy-and-cas + numerical-methods-for-odes + numerical-instability + simulation + rotations + reference-frames + quaternions + assignments/index + lecture-notes/index + sympy-live + notation + bibliography About this website =================== diff --git a/docs/installation.rst b/docs/installation.rst index 3d8a55d..255c3fe 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -47,7 +47,7 @@ Alternative 1: Miniconda 3. Install Visual Studio Code (VSCode) via `the download page `_ 4. Start VSCode and activate your newly created Python environment, ``ttk4130`` (See `this guide on python environments `_) 5. Install the following list of VSCode extensions (See `this guide on managing VSCode extensions `_): `Jupyter Extension `_, `Python Extension `_ - 6. Open or create a notebook file by opening the Command Palette (Ctrl+Shift+P) and select Jupyter: Create New Jupyter Notebook. + 6. Open or create a notebook file by opening the Command Palette (Command+Shift+P) and select Jupyter: Create New Jupyter Notebook. .. tab-item:: GNU/Linux :sync: linux @@ -64,7 +64,7 @@ Alternative 1: Miniconda 3. Install Visual Studio Code (VSCode) via `the download page `_ 4. Start VSCode and activate your newly created Python environment, ``ttk4130`` (See `this guide on python environments `_) 5. Install the following list of VSCode extensions (See `this guide on managing VSCode extensions `_): `Jupyter Extension `_, `Python Extension `_ - 6. Open or create a notebook file by opening the Command Palette (Command+Shift+P) and select Jupyter: Create New Jupyter Notebook. + 6. Open or create a notebook file by opening the Command Palette (Ctrl+Shift+P) and select Jupyter: Create New Jupyter Notebook. Troubleshooting ---------------- diff --git a/docs/jupyter-notebooks.rst b/docs/jupyter-notebook.rst similarity index 98% rename from docs/jupyter-notebooks.rst rename to docs/jupyter-notebook.rst index ee0df4c..32fb750 100644 --- a/docs/jupyter-notebooks.rst +++ b/docs/jupyter-notebook.rst @@ -1,5 +1,5 @@ ======================================= -Quick intro to Jupyter Notebooks +Quick intro to Jupyter Notebook ======================================= .. note:: @@ -74,7 +74,7 @@ There are special commands that only work in a Jupyter notebook environment. Mag %lsmagic -You can list a cheat sheet with :code`quickref` +You can list a cheat sheet with :code:`quickref` .. jupyter-execute:: diff --git a/docs/lecture-notes/index.rst b/docs/lecture-notes/index.rst new file mode 100644 index 0000000..5b8b6a4 --- /dev/null +++ b/docs/lecture-notes/index.rst @@ -0,0 +1,8 @@ +============== +Lecture Notes +============== + +.. toctree:: + :maxdepth: 1 + + week-0 diff --git a/docs/lecture-notes/week-0.rst b/docs/lecture-notes/week-0.rst new file mode 100644 index 0000000..198cf03 --- /dev/null +++ b/docs/lecture-notes/week-0.rst @@ -0,0 +1,6 @@ +============ +Week 0 +============ + +.. figure:: ../figures/week-0.svg + :align: center \ No newline at end of file