-
Notifications
You must be signed in to change notification settings - Fork 8
add teacher info to documentation #213
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
a6db19e to
92bf5a3
Compare
for more information, see https://pre-commit.ci
|
Fixed @ammedd ! |
| caption: Teaching material | ||
| --- | ||
| ILOs.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to add a thumbnail but don't think it worked. Can you have a look why it doesn't work? Is there a better workflow to add thumbnails?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to add a thumbnail but don't think it worked. Can you have a look why it doesn't work? Is there a better workflow to add thumbnails?
I think the problem here is that this document is a markdown document and not a jupyter notebook - since the package we use for this is nbsphinx its built for Jupyter notebook so adding a markdown file in the gallery is not really supported.
I think that we should just remove the gallery aspect and use a table of contents
diff --git a/docs/conf.py b/docs/conf.py
index c313f6a..ff5c555 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -76,7 +76,6 @@ nbsphinx_thumbnails = {
"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/vessel.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/teacher-content/index.md b/docs/user-guide/teacher-content/index.md
index ba1596b..a561e6a 100644
--- a/docs/user-guide/teacher-content/index.md
+++ b/docs/user-guide/teacher-content/index.md
@@ -16,7 +16,7 @@ The VSC design focuses on creating didactically sound, authentic learning experi
We evaluated in several (under)graduate courses and find that the VirtualShip Classroom is highly engaging, and students report on enhanced confidence and knowledge [(Daniels et al. 2025)](https://current-journal.com/articles/10.5334/cjme.121).
-```{nbgallery}
+```{toctree}
---
maxdepth: 1
caption: Teaching materialThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can also update the file to be a jupyter notebook, that's another option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for checking this out!
Updating the file to notebook sounds good. I'll be filling this section with more content, so it's nice to keep the gallery I guess. I'll think about it more when adding more files.
for more information, see https://pre-commit.ci

Linking to paper and some older design material