Merge pull request #77 from JSchmie/enhance_capability_with_webui #73
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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@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 |