Fix docs generation

nansencenter · Jan 29, 2024 · 16c2fc7 · 16c2fc7
1 parent 547f657
commit 16c2fc7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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