Skip to content

feat: add a calculation function that works generically for all trips #221

feat: add a calculation function that works generically for all trips

feat: add a calculation function that works generically for all trips #221

Workflow file for this run

name: Docs
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install poetry
uses: abatilo/actions-poetry@v2.3.0
- name: Install dependencies
run: poetry install --no-root
- name: Setup a local virtual environment for caching
run: |
poetry config virtualenvs.create true --local
poetry config virtualenvs.in-project true --local
- name: Define a cache for the virtual environment based on the dependencies lock file to speed up later runs
uses: actions/cache@v3
with:
path: ./.venv
key: venv-${{ hashFiles('poetry.lock') }}
- name: Install sphinx
run: pip install sphinx sphinx_rtd_theme
- name: Install myst-parser
run: pip install myst-parser
- name: Sphinx build
run: |
sphinx-build docs _build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true