Build and deploy documentation automatically to gh-pages
Change-Id: Ieb6daef389b2b5de2f78039c72a66d0148b62fc6
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
index cfec24f..2983edf 100644
--- a/.github/workflows/pythonpackage.yml
+++ b/.github/workflows/pythonpackage.yml
@@ -87,6 +87,19 @@
R_HOME: "c:/R"
R_USER: "c:/R"
PATH: "c:/R/bin/x64;${{ env.PATH }}"
+ - name: Build documentation un Linux
+ if: runner.os == 'Linux'
+ run: |
+ pip install pdoc3
+ pdoc KorAPClient --force --html -o build/doc
+ - name: Deploy documentation on Linux
+ if: runner.os == 'Linux'
+ uses: JamesIves/github-pages-deploy-action@releases/v3
+ with:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ BRANCH: gh-pages # The branch the action should deploy to.
+ FOLDER: build/doc # The folder the action should deploy.
+ TARGET_FOLDER: doc
- name: Upload check results
if: failure()
uses: actions/upload-artifact@master
diff --git a/Readme.md b/Readme.md
index c0f7ae0..b898434 100644
--- a/Readme.md
+++ b/Readme.md
@@ -40,7 +40,7 @@
python3 -m pip install git+https://github.com/KorAP/PythonKorAPClient
```
## Documentation
-The core classes and methods to access the KorAP AP are documented in the [KorAPClient API documentation](https://korap.github.io/PythonKorAPClient/html/KorAPClient/).
+The core classes and methods to access the KorAP AP are documented in the [KorAPClient API documentation](https://korap.github.io/PythonKorAPClient/doc/KorAPClient/).
For additional, mostly static helper functions, please refer to the [Refernce Manual of RKorAPClient](https://cran.r-project.org/web/packages/RKorAPClient/RKorAPClient.pdf) for now.
For translating R syntax to Python and vice versa, refer to the [rpy2 Documentation](https://rpy2.github.io/doc/latest/html/index.html).