Skip to content

Commit

Permalink
new github action to deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
onadegibert committed May 15, 2024
1 parent f95f674 commit 1305a52
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
name: Deploy docs
name: Deploy docs on GitHub Pages

on:
push:
branches:
- multi-ftt # needs to be updated
- multi-ftt # Update with your main branch or tag filters

jobs:
build-and-deploy-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.8
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.8
- name: Install dependencies to build docs
python-version: '3.8'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install wheel
pip install wheel
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
python -m pip install .[docs]
- name: Build docs
run: |
sphinx-build docs docs/build
- name: Deploy docs
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
pip install .[docs]
- name: Build docs with Sphinx
run: sphinx-build docs docs/build
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/multi-ftt'
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
Expand Down

0 comments on commit 1305a52

Please sign in to comment.