diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml index de8fa54..903c4b0 100644 --- a/.github/workflows/pdoc.yml +++ b/.github/workflows/pdoc.yml @@ -24,15 +24,18 @@ jobs: python-version: '3.11' # ADJUST THIS: install all dependencies (including pdoc) + #- run: pip install -e . #- run: pip install --upgrade pip - run: pip install pdoc + - run: pip install requests + #- run: pip install json # ADJUST THIS: build your documentation into docs/. # 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 with: - path: docs/ + path: ../../docs # Deploy the artifact to GitHub pages. # This is a separate job so that only actions/deploy-pages has the necessary permissions. diff --git a/README.md b/README.md index 5011231..bc08fd0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ # plankapy 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)