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: diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 79b0178..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: @@ -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} 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 diff --git a/README.md b/README.md index b7b5bad..f60d258 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # python-seawater -[](https://doi.org/10.5281/zenodo.11395) +[](https://zenodo.org/records/11395)  [](https://github.com/pyoceans/python-seawater/actions/workflows/tests.yml)  @@ -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