better rast_conv, oop module, docstrings and ddb stuff #16
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: docs | |
on: | |
push: | |
branches: ["main"] | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
# Build job | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: Install dependencies and build python module | |
# - uses: ammaraskar/sphinx-action@master | |
# with: | |
# docs-folder: "docs/" | |
# build-command: "sphinx-build -b html . _build" | |
run: | | |
sudo apt-get install pandoc | |
python -m pip install --upgrade pip wheel flit sphinx myst_nb furo | |
pip install --verbose .[docs] | |
- name: Build docs | |
run: | | |
sphinx-build -M html source build | |
make html | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v2 | |
with: | |
path: build/html | |
# Deployment job | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |