Skip to content

Merge pull request #104 from JSchmie/develop #80

Merge pull request #104 from JSchmie/develop

Merge pull request #104 from JSchmie/develop #80

Workflow file for this run

name: documentation
on:
push:
branches:
- main
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v3
with:
python-version: 3.9
- name: Install dependencies
run: |
sudo apt-get install libsndfile1-dev
pip install --upgrade pip
pip install -r requirements.txt
pip install --upgrade sphinx sphinx_rtd_theme myst-parser
pip install --upgrade markdown-it-py[plugins]
pip install --upgrade mdit-py-plugins
- name: Sphinx build
run: |
cp README.md ./source/README.md
cp LICENSE ./source/LICENSE
cp -r Pictures ./source/Pictures
sphinx-apidoc -o source scraibe/
sphinx-build -M html source docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/sphinx_action' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.TOKEN_GH }}
publish_dir: ./docs/html
force_orphan: true