Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
9533fdd
implement new documentation structure as per #2310
Oct 27, 2025
f7d1027
fix some links
Oct 27, 2025
d56f00f
restructure homepage
Oct 28, 2025
766d409
update community page
Oct 28, 2025
fa25497
fix some toctrees
Oct 28, 2025
08c29ab
rename documentation to user guide, consisting of tutorial, explanati…
Oct 28, 2025
0c8eacd
add LA Diag and Zulip logos
Oct 29, 2025
1a31565
move examples under user_guide
Oct 30, 2025
71096a9
introduce per-file docstring rules to apply to stable v4 code
Oct 30, 2025
ac81305
fix Zulip link
Oct 30, 2025
902f3d5
Link to GitHub image
reint-fischer Nov 3, 2025
9bb0ea6
rename "contributing" to "development"
Nov 3, 2025
3b48b95
remove parcels_contributing from sidebar
Nov 3, 2025
2d49457
start scaffolding getting_started and user_guide
Nov 3, 2025
355cde0
add some more scaffolding
Nov 3, 2025
e305182
remove some superfluous text and links
Nov 3, 2025
93f9aca
restore ruff lint ignore
Nov 3, 2025
b4bd7ff
change nav bar to make community, development, and API reference page…
Nov 4, 2025
fe9defc
Revert "start scaffolding getting_started and user_guide" to retain t…
Nov 4, 2025
7473293
Fix navigation by adding scaffolding pages
Nov 4, 2025
6cc21ea
add documentation notes to outline ideas for docs website and style g…
Nov 4, 2025
0626bee
update notebook testing folder
Nov 4, 2025
5749f57
Merge branch 'v4-dev' into documentation-structure-v4
Nov 5, 2025
8a429b7
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 5, 2025
2d1ec99
make quickstart tutorial a .md file to keep notebooks in examples fol…
Nov 5, 2025
3039320
Merge branch 'documentation-structure-v4' of https://github.com/Parce…
Nov 5, 2025
face255
Merge remote-tracking branch 'origin/v4-dev' into documentation-struc…
Nov 5, 2025
2bfef2f
fix TrajAn link
Nov 5, 2025
3f884fd
add LA Diag Cookbook link at the top of output tutorial
Nov 5, 2025
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
32 changes: 32 additions & 0 deletions docs/_static/LAdiag-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
103 changes: 103 additions & 0 deletions docs/_static/clam-full-white-buffer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/_static/github-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
104 changes: 95 additions & 9 deletions docs/community/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,107 @@
# Community

These sections contain documentation relevant to the Parcels community.
See the sections in the primary sidebar and below to explore.
```{toctree}
:caption: CLAM Community
:maxdepth: 1
:hidden:
Website <https://clam-community.github.io/>
```

```{toctree}
:caption: User documentation
:caption: GitHub
:maxdepth: 1
:hidden:
contributing
Versioning Policy <policies>
Release Notes <https://github.com/Parcels-code/Parcels/releases>
Parcels v4.0 Migration Guide <v4-migration>
Discussions <https://github.com/Parcels-code/parcels/discussions>
Issues <https://github.com/Parcels-code/parcels/issues>
```

```{toctree}
:caption: Maintainer documentation
:caption: parcels_contributions
:maxdepth: 1
:hidden:
Repository <https://github.com/Parcels-code/parcels_contributions>
```

Parcels users and developers interact in a vibrant community on a few different platforms. Check out the cards below to see how you can interact with us.

`````{grid} 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
````{grid-item-card} CLAM Community on Zulip
:img-top: ../_static/clam-full-white-buffer.svg
:shadow: md
If you are doing any kind of Lagrangian modelling and/or analysis check out the CLAM (Computational Lagrangian Analysis and Modelling) Community
```{image} https://img.shields.io/badge/Zulip-50ADFF?style=for-the-badge&logo=Zulip&logoColor=white
:width: 30%
:target: https://clam-community.zulipchat.com/
```
+++
```{button-link} https://clam-community.github.io/
:color: secondary
:expand:
To the CLAM website
```
````
````{grid-item-card} GitHub
:img-top: ../_static/github-logo.svg
:shadow: md
If you need more help with Parcels, try the Discussions page on **GitHub**. If you think you found a bug, please feel free to file an Issue.
+++
```{button-link} https://github.com/Parcels-code/parcels/discussions
:color: secondary
:expand:
Ask a question in the Discussions
```
```{button-link} https://github.com/Parcels-code/parcels/issues
:color: secondary
:expand:
Report a bug with an Issue
```
````
````{grid-item-card} Sharing user code
:shadow: md
Curious to see if someone has already written the custom `Kernel` you are thinking of or runs **Parcels** with the same hydrodynamic data? Check out the parcels_contributions repository and share examples with other users!
+++
```{button-link} https://github.com/Parcels-code/parcels_contributions
:click-parent:
:color: secondary
:expand:
Share custom Parcels code
```
````
````{grid-item-card} Lagrangian Diagnostics
:img-top: ../_static/LAdiag-logo.svg
:shadow: md
Are you interested in advanced analysis and diagnostics of Parcels output or Lagrangian trajectories in general? The Lagrangian Diagnostics project provides code and descriptions of different analyses.
+++
```{button-link} https://github.com/Parcels-code/Lagrangian_diags
:click-parent:
:color: secondary
:expand:
maintainer
Visit Lagrangian Diagnostics
```
````
`````
8 changes: 7 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"nbsphinx",
"numpydoc",
"sphinxcontrib.mermaid",
"sphinx_design",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -113,7 +114,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["_build", "**.ipynb_checkpoints"]
exclude_patterns = ["_build", "**.ipynb_checkpoints", "user_guide/examples_v3"]

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down Expand Up @@ -520,3 +521,8 @@ def linkcode_resolve(domain, info):

# If false, no index is generated.
# epub_use_index = True

# -- Options for MyST parser ----------------------------------------------
myst_heading_anchors = 3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great


myst_enable_extensions = ["substitution"]
Loading
Loading