Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"sphinx.ext.napoleon",
# "sphinx_autodoc_typehints",# https://github.com/Parcels-code/virtualship/pull/125#issuecomment-2668766302
"sphinx_copybutton",
"sphinx_design",
]

source_suffix = [".rst", ".md"]
Expand Down Expand Up @@ -44,6 +45,7 @@
"type": "fontawesome",
}
],
"announcement": "<strong>Warning</strong>: this is a pre-release version of the VirtualShip documentation (V1 to be released in September/October 2026). The contents are subject to change and may not be complete.",
}
html_context = {
"github_user": "Parcels-code",
Expand All @@ -70,20 +72,23 @@
always_document_param_types = True

nbsphinx_thumbnails = {
"user-guide/quickstart": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/tutorials/index": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/assignments/Research_proposal_intro": "user-guide/_images/MFPtimeline.jpg",
"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",
"user-guide/teacher-content/UU-ocean-of-future/Tutorial1": "user-guide/_images/freepik_assignment.png",
"user-guide/teacher-content/UU-ocean-of-future/Tutorial2": "user-guide/_images/freepik_assignment.png",
"user-guide/tutorials/surf_collaborative_setup": "user-guide/_images/freepik_research_vessel.jpg",
"user-guide/tutorials/surf_research_cloud_setup": "user-guide/_images/freepik_research_vessel.jpg",
"user-guide/tutorials/working_with_expedition_yaml": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/UU-dyoc/example_expedition": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/UU-dyoc/file_permissions": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/tutorials/codespaces_guide": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/tutorials/binder_guide": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/user-profiles/educators/letter": "user-guide/_images/freepik_research_vessel.jpg",
}

sphinx_gallery_conf = {"default_thumb_file": "_static/virtual_ship_logo.png"}
Expand Down
Loading
Loading