Issuse 33: page restructure (#34)

* Add: Lecture notes and assignments chapter * Fix typos
TTK4130 · Dec 31, 2024 · 590175d · 590175d
1 parent 29d0544
commit 590175d
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 21 deletions.
diff --git a/docs/assignment-1.rst → docs/assignments/assignment-1.rst b/docs/assignment-1.rst → 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
@@ -0,0 +1,9 @@
+============
+Assignments
+============
+
+
+.. toctree::
+    :maxdepth: 1
+
+    assignment-1
diff --git a/docs/figures/week-0.svg b/docs/figures/week-0.svg
diff --git 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
@@ -47,7 +47,7 @@ Alternative 1: Miniconda
             3. Install Visual Studio Code (VSCode) via `the download page <https://code.visualstudio.com/download>`_
             4. Start VSCode and activate your newly created Python environment, ``ttk4130`` (See `this guide on python environments <https://code.visualstudio.com/docs/python/environments>`_)
             5. Install the following list of VSCode extensions (See `this guide on managing VSCode extensions <https://code.visualstudio.com/docs/editor/extension-marketplace>`_): `Jupyter Extension <https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter>`_, `Python Extension <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`_
-            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 <https://code.visualstudio.com/download>`_
             4. Start VSCode and activate your newly created Python environment, ``ttk4130`` (See `this guide on python environments <https://code.visualstudio.com/docs/python/environments>`_)
             5. Install the following list of VSCode extensions (See `this guide on managing VSCode extensions <https://code.visualstudio.com/docs/editor/extension-marketplace>`_): `Jupyter Extension <https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter>`_, `Python Extension <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`_
-            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 → docs/jupyter-notebook.rst b/docs/jupyter-notebooks.rst → 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
@@ -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
@@ -0,0 +1,6 @@
+============
+Week 0
+============
+
+.. figure:: ../figures/week-0.svg
+   :align: center