+++ /dev/null
-name: documentation
-
-on:
- pull_request:
- types: [opened, ready_for_review]
- push:
- workflow_dispatch:
-
-permissions:
- contents: write
-
-jobs:
- docs:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v4
- - uses: actions/setup-python@v5
- - name: Install dependencies
- run: |
- pip install sphinx pallets-sphinx-themes sphinxcontrib-mermaid sphinx-new-tab-link sphinx-click
- - name: Sphinx build
- run: |
- sphinx-build docs _build
- - name: Deploy to GitHub Pages
- uses: peaceiris/actions-gh-pages@v3
- if: ${{ github.event_name == 'push'}}
- with:
- publish_branch: gh-pages
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: _build/
- force_orphan: true
--- /dev/null
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+ contents: write
+
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ - name: Install dependencies
+ run: |
+ pip install sphinx pallets-sphinx-themes sphinxcontrib-mermaid sphinx-new-tab-link sphinx-click
+ - name: Sphinx build
+ run: |
+ sphinx-build docs _build
+ - name: Deploy to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3
+ if: ${{ github.event_name == 'push'}}
+ with:
+ publish_branch: gh-pages
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: _build/
+ force_orphan: true