Skip to content

Commit 2d1ec99

Browse files
reint-fischerreint-fischer
authored andcommitted
make quickstart tutorial a .md file to keep notebooks in examples folder.
1 parent 5749f57 commit 2d1ec99

File tree

6 files changed

+11
-30
lines changed

6 files changed

+11
-30
lines changed

docs/development/docsguide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Documentation Notes
22

33
## Vision
4+
45
We believe a clear documentation is important to community building, reproducibility, and transparency in our open-source project. To make it easier to write our documentation in a consistent way, here we outline a brief vision for our documentation based heavily on a few common resources.
56

67
```{note}
78
TODO: outline functions of the documentation based on resources
89
```
10+
911
### Resources
12+
1013
- [Divio Documentation System](https://docs.divio.com/documentation-system/)
1114
- [PyOpenSci Documentation Guide](https://www.pyopensci.org/python-package-guide/documentation/index.html#)
1215
- [Write the Docs Guide](https://www.writethedocs.org/guide/)
1316
- [NumPy Documentation Article](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community)
1417

1518
## Style guide
16-
- Write documentation in first person plural ("we"). In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels.
19+
20+
- Write documentation in first person plural ("we"). In our open source code, tutorials and guides can be written by any developer or user, so the documentation teaches all of us how to do something with Parcels.

docs/getting_started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Getting started with parcels is easy; here you will find:
44

55
```{toctree}
66
Installation guide <installation.md>
7-
Quickstart tutorial <tutorial_quickstart.ipynb>
7+
Quickstart tutorial <tutorial_quickstart.md>
88
Parcels concepts explainer <concepts_overview.md>
99
<!-- Simple output tutorial <../examples_v3/tutorial_output.ipynb> -->
1010

docs/getting_started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ conda activate parcels
3333
The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcels`.
3434
```
3535

36-
**Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.ipynb) is a great way to get started immediately. You can also first read about the core [Parcels concepts](concepts_overview.md) to familiarize yourself with the classes and methods you will use.
36+
**Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.md) is a great way to get started immediately. You can also first read about the core [Parcels concepts](concepts_overview.md) to familiarize yourself with the classes and methods you will use.
3737

3838
## Installation for developers
3939

docs/getting_started/tutorial_quickstart.ipynb

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Quickstart tutorial"
2+
3+
TODO: Completely rewrite examples/parcels_tutorial.ipynb into the quickstart tutorial. Decide which file format and notebook testing to do so this file is checked, which is not in the "examples" folder

docs/user_guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ examples/tutorial_gsw_density.ipynb
7676
:name: tutorial-examples
7777
7878
examples/tutorial_Argofloats.ipynb
79-
<!-- ../examples/documentation_homepage_animation.ipynb -->
79+
<!-- examples/documentation_homepage_animation.ipynb -->
8080
```
8181

8282
```{toctree}

0 commit comments

Comments
 (0)