Skip to content

Commit

Permalink
Create docs_deploy.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
SBriere authored Oct 30, 2023
1 parent adf0016 commit d835d1a
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/docs_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Generate docs and deploy to GitHub Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.11.4]

steps:
- uses: actions/checkout@v3
with:
submodules: recursive
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}

- name: Generate base documentation
working-directory: docs
run: |
pip install -r requirements.txt
make html
touch _build/html/.nojekyll
- name: Deploy to GitHub Pages
uses: JamesIves/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/_build/html

0 comments on commit d835d1a

Please sign in to comment.