Update README.md #11
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation | |
on: [push, pull_request, workflow_dispatch] | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
- name: Set up Python virtual environment | |
run: | | |
python -m venv venv | |
source venv/bin/activate | |
pip install --upgrade pip | |
- name: Install system dependencies | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y libglu1-mesa | |
- name: Clone and install pyhexspline | |
run: | | |
venv/bin/pip install -e . | |
- name: Install dependencies | |
run: | | |
pip install sphinx sphinx_rtd_theme myst_parser | |
- name: Sphinx build | |
run: | | |
sphinx-build src/pyhexspline/docs src/pyhexspline/docs/_build | |
- name: Create .nojekyll file | |
run: | | |
touch src/pyhexspline/docs/_build/.nojekyll | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: src/pyhexspline/docs/_build | |
force_orphan: true |