github action added to build sphinx-based doc. #22
Workflow file for this run
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: Docs | |
| on: [push, pull_request, workflow_dispatch] | |
| permissions: | |
| contents: write | |
| env: | |
| BME_PROJECT_DIR: "${GITHUB_WORKSPACE}" | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/publish-sphinx-tmp' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v3 | |
| - name: Install dependencies | |
| run: | | |
| #export BME_PROJECT_DIR="${GITHUB_WORKSPACE}" | |
| echo "project dir is '${BME_PROJECT_DIR}'" | |
| pip --version | |
| pip install -r python-virtualenvs/multigit-development.requirements | |
| - name: Sphinx build | |
| run: | | |
| cd src && make doc | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: src/build/html/ | |
| force_orphan: true |