From 0b27ce643ac2025a97086123b073cff89d7d7353 Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Thu, 30 May 2024 18:58:39 +0200 Subject: [PATCH 1/5] lint --- .github/workflows/deploy-docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index e309d6a..23af3a0 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,4 +1,3 @@ - name: Documentation on: From 8c81392e96c92fd9a1cfd09677d61e0f11fdcaad Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Thu, 30 May 2024 18:58:47 +0200 Subject: [PATCH 2/5] fix folder name --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 33a2368..a1effd4 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,4 +1,4 @@ -exclude: seawater/test/seawater_v3_3/ +exclude: seawater/tests/seawater_v3_3/ repos: - repo: https://github.com/pre-commit/pre-commit-hooks From 07de789fd2350e642e883cea10885fc15e01ba9d Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Thu, 30 May 2024 18:58:53 +0200 Subject: [PATCH 3/5] install octave --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 79b0178..6b2121f 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -23,7 +23,7 @@ jobs: environment-name: TEST init-shell: bash create-args: >- - python=${{ matrix.python-version }} --file requirements.txt --file requirements-dev.txt --channel conda-forge + python=${{ matrix.python-version }} --file requirements.txt --file requirements-dev.txt octave --channel conda-forge - name: Install seawater shell: bash -l {0} From 6b29e01ba84a82e11b1fca890bb426aada096220 Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Thu, 30 May 2024 19:06:31 +0200 Subject: [PATCH 4/5] run only on Linux --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 6b2121f..e79ce41 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,7 +11,7 @@ jobs: strategy: matrix: python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ] - os: [windows-latest, ubuntu-latest, macos-latest] + os: [ubuntu-latest] fail-fast: false steps: From 1970eeb200b1aefa3aea5c02854e16f9ebe6eb8d Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Thu, 30 May 2024 19:19:57 +0200 Subject: [PATCH 5/5] fix docs --- README.md | 5 +---- docs/conf.py | 1 + docs/index.rst | 5 +++-- requirements-dev.txt | 1 + 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b7b5bad..f60d258 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # python-seawater -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11395.svg)](https://doi.org/10.5281/zenodo.11395) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11395.svg)](https://zenodo.org/records/11395) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/seawater) [![Tests](https://github.com/pyoceans/python-seawater/actions/workflows/tests.yml/badge.svg)](https://github.com/pyoceans/python-seawater/actions/workflows/tests.yml) ![PyPI - License](https://img.shields.io/pypi/l/seawater) @@ -37,6 +37,3 @@ at this that we simply ignore to avoid confusions. The current version was tested against the Matlab seawater v3.3 reproducing all functions and results from that release. - -More information at -[http://pythonhosted.org/seawater](http://pythonhosted.org/seawater). diff --git a/docs/conf.py b/docs/conf.py index eee85b6..16cfb9b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,6 +22,7 @@ # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ + "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.doctest", diff --git a/docs/index.rst b/docs/index.rst index 28eadf1..eaf6225 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,12 @@ -readme_link - Documentation ============= + .. toctree:: :maxdepth: 2 + readme_link + eos80 geostrophic extras diff --git a/requirements-dev.txt b/requirements-dev.txt index 93f882d..52ad470 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,4 +1,5 @@ matplotlib +myst-parser numpydoc oct2py pytest