Skip to content

Add autogenerated API Reference docs #7

Add autogenerated API Reference docs

Add autogenerated API Reference docs #7

Workflow file for this run

name: Push docs update
# push to the gh-pages branch whenever there is a new push to main or a new tag
on:
push:
branches:
- main
tags: ["*"]
workflow_dispatch:
permissions:
contents: write
env:
TAG: ${{ contains(github.ref, 'tags') && 'latest' || 'dev'}}
jobs:
push-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install dependencies
run: |
pip install -e ".[docs]"
- id: get_version
uses: battila7/get-version-action@v2
- name: configure git
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git fetch origin gh-pages --depth=1
- name: Push changes to gh-pages branch
run: mike deploy ${{ steps.get_version.outputs.version }} $TAG -u -p