Merge #36

36: docs r=jdroenner a=ChristianBeilschmidt



Co-authored-by: Christian Beilschmidt <[email protected]>

Author: bors[bot]

.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: APT update
+        run: sudo apt-get update
+      - name: Install system dependencies
+        run: sudo apt-get install libgeos-dev libproj-dev
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .
+
+      - name: Generate Python Docs
+        run: pdoc --html --output-dir docs geoengine
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/geoengine
+          cname: python.docs.geoengine.io

README.md

@@ -66,6 +66,14 @@ python3 -m pylint tests
 
 Our tip is to activate linting with `pylint` in your IDE.
 
+## Documentation
+
+Generate documentation HTML with:
+
+```bash
+pdoc3 --html --output-dir docs geoengine
+```
+
 ## Distribute to PyPI
 
 ### Test-PyPI

requirements.txt

@@ -1,11 +1,12 @@
 build
 cartopy==0.19.0.post1  # for WMS example
 matplotlib
+pdoc3
 pycodestyle # formatter
 pylint # code linter
 pytest
 requests_mock
-setuptools
 scipy # for WMS example
+setuptools
 twine # PyPI
 wheel