Skip to content

Commit 35cd9a7

Browse files
authored
Try to fix docs (#229)
* fix docs, mostly _images * remove broken links
1 parent 01dd168 commit 35cd9a7

File tree

6 files changed

+15
-20
lines changed

6 files changed

+15
-20
lines changed

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,9 @@
7575
"user-guide/assignments/Research_Proposal_only": "user-guide/_images/MFP.jpg",
7676
"user-guide/assignments/Virtualship_research_proposal": "user-guide/_images/AnnaWeber.jpeg",
7777
"user-guide/assignments/sciencecommunication_assignment": "user-guide/_images/marine_ss.jpg",
78-
"user-guide/assignments/Sail_the_ship": "user-guide/_images/freepik_research_vessel.jpg",
78+
# "user-guide/assignments/Sail_the_ship": "user-guide/_images/freepik_research_vessel.jpg",
7979
"user-guide/assignments/Code_of_conduct": "user-guide/_images/freepik_code_of_conduct.jpg",
80+
"user-guide/teacher-content/ILOs": "user-guide/_images/ILOs.jpg",
8081
}
8182

8283
sphinx_gallery_conf = {"default_thumb_file": "_static/virtual_ship_logo.png"}

docs/user-guide/_images/links.ipynb

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,21 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7+
"# Images used in the documentation\n",
8+
"\n",
79
"[AnnaWeber](AnnaWeber.jpeg)\n",
810
"\n",
911
"[MFP_planning](MFP.jpg)\n",
1012
"\n",
1113
"[MFP_timeline](MFPtimeline.jpg)\n",
1214
"\n",
13-
"[Marine_soft_skills](marine_ss.jpg)"
15+
"[Marine_soft_skills](marine_ss.jpg)\n",
16+
"\n",
17+
"[Code_of_conduct](freepik_code_of_conduct.jpg)\n",
18+
"\n",
19+
"[Research_vessel](freepik_research_vessel.jpg)\n",
20+
"\n",
21+
"[ILOs](ILOs.jpg)"
1422
]
1523
}
1624
],

docs/user-guide/assignments/Code_of_conduct.ipynb

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"cell_type": "markdown",
2222
"metadata": {},
2323
"source": [
24-
"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",
24+
"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",
2525
"\n",
2626
"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",
2727
"\n",
@@ -85,13 +85,6 @@
8585
"\n",
8686
"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"
8787
]
88-
},
89-
{
90-
"cell_type": "markdown",
91-
"metadata": {},
92-
"source": [
93-
"[Thumbnail image](_images/freepik_code_of_conduct.jpg)"
94-
]
9588
}
9689
],
9790
"metadata": {

docs/user-guide/assignments/Sail_the_ship.ipynb

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,13 +177,6 @@
177177
"![Our ocean provides](https://seewhatgrows.org/wp-content/uploads/2019/06/our-ocean.jpg)\n",
178178
"![10 ways to help our ocean](https://oceanservice.noaa.gov/ocean/help-ocean.jpg)"
179179
]
180-
},
181-
{
182-
"cell_type": "markdown",
183-
"metadata": {},
184-
"source": [
185-
"[Thumbnail image](_images/freepik_research_vessel.jpg)"
186-
]
187180
}
188181
],
189182
"metadata": {

docs/user-guide/assignments/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Virtualship_research_proposal.ipynb
99
Research_proposal_intro.ipynb
1010
Research_Proposal_only.ipynb
1111
sciencecommunication_assignment.ipynb
12-
<!-- Sail_the_ship.ipynb -->
12+
Code_of_conduct.ipynb
1313
```

docs/user-guide/teacher-content/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ VirtualShip is used as part of the VirtualShip Classroom, that combines authenti
44

55
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.
66

7-
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).
7+
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).
88

99
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:
1010

@@ -22,5 +22,5 @@ maxdepth: 1
2222
caption: Teaching material
2323
---
2424
25-
ILOs.md
25+
ILOs.ipynb
2626
```

0 commit comments

Comments
 (0)