From 42bea99c6bcaa98876e2d5229793fd11b83b458e Mon Sep 17 00:00:00 2001 From: Sylwester Arabas Date: Wed, 28 Aug 2024 13:56:45 +0200 Subject: [PATCH] switch from pdoc3 to pdoc (#123) --- .github/workflows/tests+pypi.yml | 6 +++--- README.md | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/tests+pypi.yml b/.github/workflows/tests+pypi.yml index c273e09..1b3f52a 100644 --- a/.github/workflows/tests+pypi.yml +++ b/.github/workflows/tests+pypi.yml @@ -46,15 +46,15 @@ jobs: - uses: mpi4py/setup-mpi@v1 - name: Build run: | - pip install pdoc3 + pip install pdoc pip install -e . - python -We -m pdoc --html PyMPDATA_MPI + python -We -m pdoc -o html PyMPDATA_MPI - name: Deploy if: github.ref == 'refs/heads/main' uses: JamesIves/github-pages-deploy-action@4.1.1 with: BRANCH: pdoc - FOLDER: html/PyMPDATA_MPI + FOLDER: html CLEAN: true zenodo_json: diff --git a/README.md b/README.md index ee1b559..b2d5c33 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,9 @@ [![GitHub issues](https://img.shields.io/github/issues-closed/open-atmos/PyMPDATA-MPI.svg?logo=github&logoColor=white)](https://github.com/open-atmos/PyMPDATA-MPI/issues?q=is:closed) [![Github Actions Build Status](https://github.com/open-atmos/PyMPDATA-MPI/workflows/tests+pypi/badge.svg?branch=main)](https://github.com/open-atmos/PyMPDATA-MPI/actions) [![PyPI version](https://badge.fury.io/py/PyMPDATA-MPI.svg)](https://pypi.org/project/PyMPDATA-MPI) -[![API docs](https://img.shields.io/badge/API_docs-pdoc3-blue.svg)](https://open-atmos.github.io/PyMPDATA-MPI/) +[![API docs](https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg)](https://open-atmos.github.io/PyMPDATA-MPI/) [![Coverage Status](https://codecov.io/gh/open-atmos/PyMPDATA-MPI/branch/main/graph/badge.svg)](https://app.codecov.io/gh/open-atmos/PyMPDATA-MPI) - PyMPDATA-MPI constitutes a [PyMPDATA](https://github.com/open-atmos/PyMPDATA) + [numba-mpi](https://github.com/numba-mpi/numba-mpi) coupler enabling numerical solutions of transport equations with the MPDATA numerical scheme in a