Skip to content

Merge pull request #1 from shnmrt/main #1

Merge pull request #1 from shnmrt/main

Merge pull request #1 from shnmrt/main #1

Workflow file for this run

name: Build & Deploy Docs
on:
push:
branches: [main]
permissions:
contents: write
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install depdencies
run: |
python -m pip install -U pip
pip install .
pip install sphinx sphinx-rtd-theme
- name: Build Docs
run: sphinx-build -b html docs/source docs/_build/html
- name: add .nojekyll
run: touch docs/_build/html/.nojekyll
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
publish_branch: gh-pages
force_orphan: true