From 16c2fc743a37b53e5abb81a9c6acb2b481f5ac33 Mon Sep 17 00:00:00 2001 From: patnr Date: Mon, 29 Jan 2024 09:16:19 +0100 Subject: [PATCH] Fix docs generation --- .github/workflows/deploy-docs.yml | 2 +- dapper/README.md | 4 ++-- docs/dev_guide.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 34801a9c..6ab3295b 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -27,7 +27,7 @@ jobs: python-version: '3.10' - run: pip install -e .[build] - - run: pdoc -o docs-generated/ -t docs/templates --math docs/bib/bib.py docs/dev_guide.py ./dapper + - run: pdoc -o docs-generated/ -t docs/templates --math --docformat=numpy docs/bib/bib.py docs/dev_guide.py ./dapper - uses: actions/upload-pages-artifact@v1 with: diff --git a/dapper/README.md b/dapper/README.md index 6be82ae7..ed35297b 100644 --- a/dapper/README.md +++ b/dapper/README.md @@ -26,8 +26,8 @@ your own **model** or **method**, then rather than trying to squeeze everything into its templates. - If it is relatively simple, however, you may well want to use DAPPER. In that case, read this: - - `mods` - - `da_methods` + - `dapper.mods` + - `dapper.da_methods` Since the generality of DAPPER is [limited](https://github.com/nansencenter/DAPPER#similar-projects) diff --git a/docs/dev_guide.md b/docs/dev_guide.md index 2dbfec79..d8bbfe8b 100644 --- a/docs/dev_guide.md +++ b/docs/dev_guide.md @@ -110,7 +110,7 @@ the `lightscript` format), so that the paired files can be kept in synch. The documentation is built with `pdoc`, e.g. ```sh -pdoc -t docs/templates --math docs/bib/bib.py docs/dev_guide.py ./dapper +pdoc -t docs/templates --math --docformat=numpy docs/bib/bib.py docs/dev_guide.py ./dapper ``` ##### Hosting