Merge pull request #26 from muon-spectroscopy-computational-project/2… #4
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
#Workflow to deploy sphinx documentation to github pages | |
name: Deploy Sphinx Documentation | |
on: | |
push: | |
branches: | |
- test-ci | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.12' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install sphinx sphinx_rtd_theme | |
- name: Build documentation | |
id: build-docs | |
run: | | |
sphinx-build -M html docs/source docs/build | |
- name: Deploy to Github pages | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ${{ steps.build-docs.outputs.artifact }} | |