Skip to content

Automatically update API docs on release #7

Automatically update API docs on release

Automatically update API docs on release #7

Workflow file for this run

name: Build Documentation
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
release:
types:
- created
permissions:
contents: write
pages: write
jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Install Quartodoc dependencies
run: pip install .[docs]
- name: Qartodoc Build
run: quartodoc build --config docs/_quarto.yam
- name: Render Docs
uses: quarto-dev/quarto-actions/render@v2
with:
path: docs/
- name: Publish Rendered Docs
# if: github.event_name == 'release'
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
path: docs/
render: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./docs/_build
# publish_branch: gh-pages
# force_orphan: true