-
Notifications
You must be signed in to change notification settings - Fork 164
Documentation structure v4 #2349
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
Merged
Merged
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
f7d1027
fix some links
d56f00f
restructure homepage
766d409
update community page
fa25497
fix some toctrees
08c29ab
rename documentation to user guide, consisting of tutorial, explanati…
0c8eacd
add LA Diag and Zulip logos
1a31565
move examples under user_guide
71096a9
introduce per-file docstring rules to apply to stable v4 code
ac81305
fix Zulip link
902f3d5
Link to GitHub image
reint-fischer 9bb0ea6
rename "contributing" to "development"
3b48b95
remove parcels_contributing from sidebar
2d49457
start scaffolding getting_started and user_guide
355cde0
add some more scaffolding
e305182
remove some superfluous text and links
93f9aca
restore ruff lint ignore
b4bd7ff
change nav bar to make community, development, and API reference page…
fe9defc
Revert "start scaffolding getting_started and user_guide" to retain t…
7473293
Fix navigation by adding scaffolding pages
6cc21ea
add documentation notes to outline ideas for docs website and style g…
0626bee
update notebook testing folder
5749f57
Merge branch 'v4-dev' into documentation-structure-v4
8a429b7
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 2d1ec99
make quickstart tutorial a .md file to keep notebooks in examples fol…
3039320
Merge branch 'documentation-structure-v4' of https://github.com/Parce…
face255
Merge remote-tracking branch 'origin/v4-dev' into documentation-struc…
2bfef2f
fix TrajAn link
3f884fd
add LA Diag Cookbook link at the top of output tutorial
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
VeckoTheGecko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| :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 | ||
| ``` | ||
| ```` | ||
| ````` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,6 +40,7 @@ | |
| "nbsphinx", | ||
| "numpydoc", | ||
| "sphinxcontrib.mermaid", | ||
| "sphinx_design", | ||
| ] | ||
|
|
||
| # Add any paths that contain templates here, relative to this directory. | ||
|
|
@@ -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. | ||
|
|
@@ -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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is great |
||
|
|
||
| myst_enable_extensions = ["substitution"] | ||
VeckoTheGecko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.