Skip to content

Merge pull request #809 from StingraySoftware/v2_release_branch #164

Merge pull request #809 from StingraySoftware/v2_release_branch

Merge pull request #809 from StingraySoftware/v2_release_branch #164

Workflow file for this run

name: Build & publish documentation to GitHub Pages
on:
push:
branches:
- main
release:
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: true
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install pandoc
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[docs]"
- name: Build documentation
run: sphinx-build -b html -d _build/doctrees . _build/html
working-directory: docs
- name: Deploy to GitHub Pages
if: success()
uses: crazy-max/ghaction-github-pages@v3
with:
target_branch: gh-pages
build_dir: docs/_build/html
fqdn: docs.stingray.science
jekyll: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}