Skip to content

Update README.md

Update README.md #19

Workflow file for this run

name: Documentation
on:
push:
branches: main
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
container: mrbuche/exodus
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install
run: |
python -m venv venv
. venv/bin/activate
pip install .[cpu,docs]
cd docs
sphinx-apidoc -o source/ ../pancax -P
make html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
force_orphan: true