From eec05d8ac75ace3f4688f680659deac0d1a52806 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:25:04 +0200 Subject: [PATCH 1/4] patch readthedocs build --- .readthedocs.yaml | 1 + environment.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 8bbb0d95..01f7df4e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,6 +9,7 @@ build: python: mambaforge-22.9 jobs: pre_build: + - pip install . - sphinx-build -b linkcheck docs/ _build/linkcheck - sphinx-apidoc -o docs/api/ --module-first --no-toc --force src/virtualship diff --git a/environment.yml b/environment.yml index 14389240..0865f534 100644 --- a/environment.yml +++ b/environment.yml @@ -1,6 +1,5 @@ name: ship channels: - - defaults - conda-forge dependencies: - click @@ -10,6 +9,7 @@ dependencies: - opensimplex == 0.4.5 - numpy >=1, < 2 - pydantic >=2, <3 + - pip # linting - pre-commit From 8358880b0d23ba4c8e6bb19df69e8dfdd13abfee Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:55:50 +0200 Subject: [PATCH 2/4] update readme --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 17846c1e..f3c6f957 100644 --- a/README.md +++ b/README.md @@ -96,9 +96,7 @@ Options: ``` -For examples, see LINK_TO_TURORIALS. - - +For examples, see [the tutorials section of our documentation](https://virtualship.readthedocs.io/en/latest/tutorials/index.html). ## Input data From 0be23eb009e1f8e95b0170294d813bbea848e5f1 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:57:33 +0200 Subject: [PATCH 3/4] disable linkcheck --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 01f7df4e..10735273 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,7 +10,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: From e5da48667c0819f7dbbc09b56194c8e626728bad Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Tue, 8 Oct 2024 13:31:40 +0200 Subject: [PATCH 4/4] update documentation link --- README.md | 2 +- pyproject.toml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3c6f957..1ecf867a 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Options: ``` -For examples, see [the tutorials section of our documentation](https://virtualship.readthedocs.io/en/latest/tutorials/index.html). +For examples, see [the tutorials section of our documentation](https://virtualship.oceanparcels.org/en/latest/tutorials/index.html). ## Input data diff --git a/pyproject.toml b/pyproject.toml index e99c5b22..775ba2a1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,6 +37,7 @@ dependencies = [ [project.urls] Homepage = "https://oceanparcels.org/" # TODO: Update this to just be repo? Repository = "https://github.com/OceanParcels/virtualship" +Documentation = "https://virtualship.oceanparcels.org/" "Bug Tracker" = "https://github.com/OceanParcels/virtualship/issues" Changelog = "https://github.com/OceanParcels/virtualship/releases"