Skip to content

Issue #17: Sphinx documentation #13

Issue #17: Sphinx documentation

Issue #17: Sphinx documentation #13

Workflow file for this run

name: Documentation
on: [pull_request]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: Mock Basilisk
run: |
cp docs/sitecustomize.py $(python -c 'import site; print(site.getsitepackages()[0])')/sitecustomize.py
- name: Install dependencies
run: |
pip install -e .
# skip finish install steps
- name: Sphinx build
run: |
cd docs
make html
cd ..
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
force_orphan: true
# - name: Setup Pages
# uses: actions/configure-pages@v4
# - name: Build with Jekyll
# uses: actions/jekyll-build-pages@v1
# with:
# source: ./docs
# destination: ./_site
# - name: Upload artifact
# uses: actions/upload-pages-artifact@v3
# Deployment job
# deploy:
# runs-on: ubuntu-latest
# needs: build
# steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v4