Skip to content

Commit

Permalink
add workflow for documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
VascoSch92 committed Feb 23, 2024
1 parent 0d85268 commit 57a3c8d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: documentation

on:
push:
branches:
- docs

jobs:
docs:
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.10"
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Generate the docs
run: |
cd docs
make generate-docs
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: build
force_orphan: true

0 comments on commit 57a3c8d

Please sign in to comment.