diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 8bbb0d95..10735273 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,8 @@ build: python: mambaforge-22.9 jobs: pre_build: - - sphinx-build -b linkcheck docs/ _build/linkcheck + - pip install . + # - 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 17846c1e..1ecf867a 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.oceanparcels.org/en/latest/tutorials/index.html). ## Input data 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 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"