From c4f027b8240a0a09fa9226a2e6c4b92f63f6ddfb Mon Sep 17 00:00:00 2001 From: Emma Daniels Date: Thu, 13 Nov 2025 16:47:07 +0100 Subject: [PATCH 1/2] fix docs --- docs/conf.py | 3 ++- docs/user-guide/_images/links.ipynb | 10 +++++++++- docs/user-guide/assignments/index.md | 2 +- docs/user-guide/teacher-content/index.md | 2 +- 4 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 27353cbb..07661eb0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -75,8 +75,9 @@ "user-guide/assignments/Research_Proposal_only": "user-guide/_images/MFP.jpg", "user-guide/assignments/Virtualship_research_proposal": "user-guide/_images/AnnaWeber.jpeg", "user-guide/assignments/sciencecommunication_assignment": "user-guide/_images/marine_ss.jpg", - "user-guide/assignments/Sail_the_ship": "user-guide/_images/freepik_research_vessel.jpg", + # "user-guide/assignments/Sail_the_ship": "user-guide/_images/freepik_research_vessel.jpg", "user-guide/assignments/Code_of_conduct": "user-guide/_images/freepik_code_of_conduct.jpg", + "user-guide/teacher-content/ILOs": "user-guide/_images/ILOs.jpg", } sphinx_gallery_conf = {"default_thumb_file": "_static/virtual_ship_logo.png"} diff --git a/docs/user-guide/_images/links.ipynb b/docs/user-guide/_images/links.ipynb index 95f55cbb..57849248 100644 --- a/docs/user-guide/_images/links.ipynb +++ b/docs/user-guide/_images/links.ipynb @@ -4,13 +4,21 @@ "cell_type": "markdown", "metadata": {}, "source": [ + "# Images used in the documentation\n", + "\n", "[AnnaWeber](AnnaWeber.jpeg)\n", "\n", "[MFP_planning](MFP.jpg)\n", "\n", "[MFP_timeline](MFPtimeline.jpg)\n", "\n", - "[Marine_soft_skills](marine_ss.jpg)" + "[Marine_soft_skills](marine_ss.jpg)\n", + "\n", + "[Code_of_conduct](freepik_code_of_conduct.jpg)\n", + "\n", + "[Research_vessel](freepik_research_vessel.jpg)\n", + "\n", + "[ILOs](ILOs.jpg)" ] } ], diff --git a/docs/user-guide/assignments/index.md b/docs/user-guide/assignments/index.md index 0e0db109..40791b79 100644 --- a/docs/user-guide/assignments/index.md +++ b/docs/user-guide/assignments/index.md @@ -9,5 +9,5 @@ Virtualship_research_proposal.ipynb Research_proposal_intro.ipynb Research_Proposal_only.ipynb sciencecommunication_assignment.ipynb - +Code_of_conduct.ipynb ``` diff --git a/docs/user-guide/teacher-content/index.md b/docs/user-guide/teacher-content/index.md index ba1596b6..dcaee4ca 100644 --- a/docs/user-guide/teacher-content/index.md +++ b/docs/user-guide/teacher-content/index.md @@ -22,5 +22,5 @@ maxdepth: 1 caption: Teaching material --- -ILOs.md +ILOs.ipynb ``` From a270c4513693c1f503eb20865ee4d332a923d77c Mon Sep 17 00:00:00 2001 From: Emma Daniels Date: Thu, 13 Nov 2025 17:03:15 +0100 Subject: [PATCH 2/2] broken links --- docs/user-guide/assignments/Code_of_conduct.ipynb | 9 +-------- docs/user-guide/assignments/Sail_the_ship.ipynb | 7 ------- docs/user-guide/teacher-content/index.md | 2 +- 3 files changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/user-guide/assignments/Code_of_conduct.ipynb b/docs/user-guide/assignments/Code_of_conduct.ipynb index 470add25..4c791b69 100644 --- a/docs/user-guide/assignments/Code_of_conduct.ipynb +++ b/docs/user-guide/assignments/Code_of_conduct.ipynb @@ -21,7 +21,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "This code of conduct has been decided by [NAMES] for their group project during the Virtual Ship Classroom and is enacted from [DD-MM-YYYY]. The procedure is based on [this exercise by Aurelia Moser](http://aureliamoser.com/aaas-guides/conduct/index.html)\n", + "This code of conduct has been decided by [NAMES] for their group project during the Virtual Ship Classroom and is enacted from [DD-MM-YYYY]. The procedure is based an exercise by Aurelia Moser.\n", "\n", "Everyone taking part in the course and group discussions (mentors, helpers, coordinators, and learners) is required to conform to the following Code of Conduct. Coordinators will oversee adherence to this code throughout the course.\n", "\n", @@ -85,13 +85,6 @@ "\n", "The course coordinator reserves the right to refuse admission to anyone violating these policies, and/or take further action including reporting to the responsible figure for academic integrity at the department.\n" ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "[Thumbnail image](_images/freepik_code_of_conduct.jpg)" - ] } ], "metadata": { diff --git a/docs/user-guide/assignments/Sail_the_ship.ipynb b/docs/user-guide/assignments/Sail_the_ship.ipynb index 8bfcd463..3f62d06a 100644 --- a/docs/user-guide/assignments/Sail_the_ship.ipynb +++ b/docs/user-guide/assignments/Sail_the_ship.ipynb @@ -177,13 +177,6 @@ "![Our ocean provides](https://seewhatgrows.org/wp-content/uploads/2019/06/our-ocean.jpg)\n", "![10 ways to help our ocean](https://oceanservice.noaa.gov/ocean/help-ocean.jpg)" ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "[Thumbnail image](_images/freepik_research_vessel.jpg)" - ] } ], "metadata": { diff --git a/docs/user-guide/teacher-content/index.md b/docs/user-guide/teacher-content/index.md index dcaee4ca..d3b6f5c8 100644 --- a/docs/user-guide/teacher-content/index.md +++ b/docs/user-guide/teacher-content/index.md @@ -4,7 +4,7 @@ VirtualShip is used as part of the VirtualShip Classroom, that combines authenti All VirtualShip Classroom (VSC) material is open under an MIT licence and freely available! You can use the VSC to teach anything from a 4 hour masterclass up to an open assignment of more than 40 hours. Example assignments are available below and please feel free to customize anything offline or [contribute](../../contributing/index.md) to the assignments provided here. -Our core learning outcome is for students to appreciate the difficulty of measuring the ocean, making the VSC a valuable tool for students that will go into fieldwork, modelling or anything else. Additional Intended Learning Outcomes [(ILOs)](ILOs.md) were formulated in collaboration with ocean scientists from the Royal Netherlands Institute for Sea Research [(NIOZ)](https://www.nioz.nl/en) and Utrecht University [(UU)](https://www.uu.nl/en). +Our core learning outcome is for students to appreciate the difficulty of measuring the ocean, making the VSC a valuable tool for students that will go into fieldwork, modelling or anything else. Additional Intended Learning Outcomes [(ILOs)](ILOs.ipnb) were formulated in collaboration with ocean scientists from the Royal Netherlands Institute for Sea Research [(NIOZ)](https://www.nioz.nl/en) and Utrecht University [(UU)](https://www.uu.nl/en). The 360 videos are available on our YouTube channel [**_@VirtualShip Classroom_**](https://www.youtube.com/@VirtualShipClassroom) and in high resolution upon request. The videos can be viewed in the classroom or at home using: