diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7bbecf3d..1101af02 100644 --- 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 index 008f448d..2093f7c3 100644 --- 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 index 1c13b28a..922b915e 100644 --- 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 index 04ea6c19..2c4223d8 100644 --- 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/ -**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 new file mode 100644 index 00000000..827e4689 --- /dev/null +++ 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 b/docs/contributing/index.md similarity index 100% rename from docs/contributing.md rename to docs/contributing/index.md diff --git a/docs/index.md b/docs/index.md index cbcf94ea..66bc81b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,9 +5,9 @@ :hidden: Home -quickstart -tutorials/index -contributing +user-guide/index +api/index +contributing/index OceanParcels ``` diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md new file mode 100644 index 00000000..0699fe0c --- /dev/null +++ b/docs/user-guide/index.md @@ -0,0 +1,8 @@ +# User Guide + +```{toctree} +:maxdepth: 1 + +quickstart +tutorials/index +``` diff --git a/docs/quickstart.md b/docs/user-guide/quickstart.md similarity index 100% rename from docs/quickstart.md rename to docs/user-guide/quickstart.md diff --git a/docs/tutorials/ADCP_data_tutorial.ipynb b/docs/user-guide/tutorials/ADCP_data_tutorial.ipynb similarity index 100% rename from docs/tutorials/ADCP_data_tutorial.ipynb rename to docs/user-guide/tutorials/ADCP_data_tutorial.ipynb diff --git a/docs/tutorials/CTD_data_tutorial.ipynb b/docs/user-guide/tutorials/CTD_data_tutorial.ipynb similarity index 100% rename from docs/tutorials/CTD_data_tutorial.ipynb rename to docs/user-guide/tutorials/CTD_data_tutorial.ipynb diff --git a/docs/tutorials/Drifter_data_tutorial.ipynb b/docs/user-guide/tutorials/Drifter_data_tutorial.ipynb similarity index 100% rename from docs/tutorials/Drifter_data_tutorial.ipynb rename to docs/user-guide/tutorials/Drifter_data_tutorial.ipynb diff --git a/docs/tutorials/index.md b/docs/user-guide/tutorials/index.md similarity index 100% rename from docs/tutorials/index.md rename to docs/user-guide/tutorials/index.md diff --git a/docs/tutorials/sciencecommunication_assignment.ipynb b/docs/user-guide/tutorials/sciencecommunication_assignment.ipynb similarity index 100% rename from docs/tutorials/sciencecommunication_assignment.ipynb rename to docs/user-guide/tutorials/sciencecommunication_assignment.ipynb