Parcels-code · VeckoTheGecko · Jan 23, 2025 · Jan 22, 2025 · Jan 22, 2025 · Jan 22, 2025
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1 +1 @@
-See the following [contributing guide](https://virtualship.oceanparcels.org/en/latest/contributing.html).
+See the following [contributing guide](https://virtualship.oceanparcels.org/en/latest/contributing/index.html).
diff --git a/.gitignore b/.gitignore
@@ -81,7 +81,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-docs/api/
+docs/api/*
+!docs/api/index.md
 
 # PyBuilder
 .pybuilder/

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -11,7 +11,7 @@ build:
   jobs:
     pre_build:
       - pip install .
-      - sphinx-build -b linkcheck docs/ _build/linkcheck
+      # - sphinx-build -b linkcheck docs/ _build/linkcheck
       - sphinx-apidoc -o docs/api/ --module-first --no-toc --force src/virtualship
 
 conda:

diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ conda activate ship
 
 which creates an environment named `ship` with the latest version of `virtualship`. You can replace `ship` with any name you like.
 
-For a development installation, please follow the instructions detailed in the [contributing page](https://virtualship.oceanparcels.org/en/latest/contributing.html).
+For a development installation, please follow the instructions detailed in the [contributing page](https://virtualship.oceanparcels.org/en/latest/contributing/index.html).
 
 ## Usage
 
@@ -113,7 +113,7 @@ Options:
   --help  Show this message and exit.
 ```
 
-For examples, see [the tutorials section of our documentation](https://virtualship.oceanparcels.org/en/latest/tutorials/index.html).
+For examples, see [the tutorials section of our documentation](https://virtualship.oceanparcels.org/en/latest/user-guide/tutorials/index.html).
 
 ## Input data
 
@@ -129,5 +129,5 @@ The code for this project is [hosted on GitHub](https://github.com/OceanParcels/
   <img src="https://contrib.rocks/image?repo=oceanparcels/virtualship" />
 </a>
 
-**All contributions are welcome! See the [contributing page](https://virtualship.oceanparcels.org/en/latest/contributing.html) in our documentation to see how to get involved.**
+**All contributions are welcome! See the [contributing page](https://virtualship.oceanparcels.org/en/latest/contributing/index.html) in our documentation to see how to get involved.**
 Image made with [contrib.rocks](https://contrib.rocks).
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,9 @@
+# API
+
+```{caution}
+This project is in active development, and the Python API is subject to change. This documentation serves as reference for developers or those interested in the internals of the project. Pivate methods (i.e., preceding with an underscore) are not included here.
+```
+
+```{toctree}
+virtualship
+```
diff --git a/docs/contributing.md → docs/contributing/index.md b/docs/contributing.md → docs/contributing/index.md
diff --git a/docs/index.md b/docs/index.md
@@ -5,9 +5,9 @@
 :hidden:
 
 Home <self>
-quickstart
-tutorials/index
-contributing
+user-guide/index
+api/index
+contributing/index
 OceanParcels <https://oceanparcels.org>
 ```
 

diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md
@@ -0,0 +1,8 @@
+# User Guide
+
+```{toctree}
+:maxdepth: 1
+
+quickstart
+tutorials/index
+```
diff --git a/docs/quickstart.md → docs/user-guide/quickstart.md b/docs/quickstart.md → docs/user-guide/quickstart.md
diff --git a/docs/tutorials/ADCP_data_tutorial.ipynb → ...-guide/tutorials/ADCP_data_tutorial.ipynb b/docs/tutorials/ADCP_data_tutorial.ipynb → ...-guide/tutorials/ADCP_data_tutorial.ipynb
diff --git a/docs/tutorials/CTD_data_tutorial.ipynb → ...r-guide/tutorials/CTD_data_tutorial.ipynb b/docs/tutorials/CTD_data_tutorial.ipynb → ...r-guide/tutorials/CTD_data_tutorial.ipynb
diff --git a/docs/tutorials/Drifter_data_tutorial.ipynb → ...ide/tutorials/Drifter_data_tutorial.ipynb b/docs/tutorials/Drifter_data_tutorial.ipynb → ...ide/tutorials/Drifter_data_tutorial.ipynb
diff --git a/docs/tutorials/index.md → docs/user-guide/tutorials/index.md b/docs/tutorials/index.md → docs/user-guide/tutorials/index.md
diff --git a/...als/sciencecommunication_assignment.ipynb → ...als/sciencecommunication_assignment.ipynb b/...als/sciencecommunication_assignment.ipynb → ...als/sciencecommunication_assignment.ipynb
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		See the following [contributing guide](https://virtualship.oceanparcels.org/en/latest/contributing.html).
		See the following [contributing guide](https://virtualship.oceanparcels.org/en/latest/contributing/index.html).