This commit is contained in:
hwelch-fle 2023-05-01 15:50:14 -04:00
commit 4eceb43d44
2 changed files with 6 additions and 3 deletions

View file

@ -24,15 +24,18 @@ jobs:
python-version: '3.11' python-version: '3.11'
# ADJUST THIS: install all dependencies (including pdoc) # ADJUST THIS: install all dependencies (including pdoc)
#- run: pip install -e .
#- run: pip install --upgrade pip #- run: pip install --upgrade pip
- run: pip install pdoc - run: pip install pdoc
- run: pip install requests
#- run: pip install json
# ADJUST THIS: build your documentation into docs/. # ADJUST THIS: build your documentation into docs/.
# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
- run: pdoc -d markdown -o docs/ plankapy.py - run: python3 -m pdoc -d markdown -o ../../docs ../../plankapy.py
- uses: actions/upload-pages-artifact@v1 - uses: actions/upload-pages-artifact@v1
with: with:
path: docs/ path: ../../docs
# Deploy the artifact to GitHub pages. # Deploy the artifact to GitHub pages.
# This is a separate job so that only actions/deploy-pages has the necessary permissions. # This is a separate job so that only actions/deploy-pages has the necessary permissions.

View file

@ -1,4 +1,4 @@
# plankapy # plankapy
A python 3 based API for controlling a self-hosted Planka instance A python 3 based API for controlling a self-hosted Planka instance
[Docs](https://hwelch-fle.github.io) [Docs](https://hwelch-fle.github.io/plankapy/plankapy.html)