From 7d7e5306f647308524fa0cd23e5645bb134422d7 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 22 Jan 2025 16:06:31 +0100 Subject: [PATCH 1/5] Restructure documentation --- docs/{contributing.md => contributing/index.md} | 0 docs/index.md | 6 +++--- docs/user-guide/index.md | 8 ++++++++ docs/{ => user-guide}/quickstart.md | 0 docs/{ => user-guide}/tutorials/ADCP_data_tutorial.ipynb | 0 docs/{ => user-guide}/tutorials/CTD_data_tutorial.ipynb | 0 .../tutorials/Drifter_data_tutorial.ipynb | 0 docs/{ => user-guide}/tutorials/index.md | 0 .../tutorials/sciencecommunication_assignment.ipynb | 0 9 files changed, 11 insertions(+), 3 deletions(-) rename docs/{contributing.md => contributing/index.md} (100%) create mode 100644 docs/user-guide/index.md rename docs/{ => user-guide}/quickstart.md (100%) rename docs/{ => user-guide}/tutorials/ADCP_data_tutorial.ipynb (100%) rename docs/{ => user-guide}/tutorials/CTD_data_tutorial.ipynb (100%) rename docs/{ => user-guide}/tutorials/Drifter_data_tutorial.ipynb (100%) rename docs/{ => user-guide}/tutorials/index.md (100%) rename docs/{ => user-guide}/tutorials/sciencecommunication_assignment.ipynb (100%) 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 From ebc1a0e4c54aaddca53baaf682e6e6588ae7cbc5 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 22 Jan 2025 16:43:04 +0100 Subject: [PATCH 2/5] Fix API documentation --- .gitignore | 3 ++- docs/api/index.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 docs/api/index.md 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/docs/api/index.md b/docs/api/index.md new file mode 100644 index 00000000..22eae045 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,10 @@ +# 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 +``` From 90b69e3e02b35d5a700cea9ba9bd11601ce14014 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 22 Jan 2025 16:44:37 +0100 Subject: [PATCH 3/5] Update references --- .github/CONTRIBUTING.md | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) 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/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). From b90dfab03850cf8533a1b38fc01f5bf0b2ad98e3 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:44:48 +0000 Subject: [PATCH 4/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/api/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/api/index.md b/docs/api/index.md index 22eae045..827e4689 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -4,7 +4,6 @@ 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 ``` From 55d15c09464a79e6cd604354df8819adee2ff9ac Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Thu, 23 Jan 2025 13:03:13 +0100 Subject: [PATCH 5/5] temp: disable linkcheck --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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: