Skip to content

github action added to build sphinx-based doc. #41

github action added to build sphinx-based doc.

github action added to build sphinx-based doc. #41

Workflow file for this run

---
name: Publish Sphinx doc to gh-pages
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
sphinx_doc:
runs-on: ubuntu-latest
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/publish-sphinx' }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- name: Install dependencies
run: |
export BME_PROJECT_DIR="${GITHUB_WORKSPACE}"
echo "Python version: "`python --version`
echo "pip version: "`pip --version`
pip install Sphinx==5.3.0 sphinxcontrib-programoutput==0.17 sphinx-rtd-theme==1.1.0 \
GitPython==3.1.24 Cerberus==1.3.4
- name: Sphinx build
run: |
cd "${GITHUB_WORKSPACE}/src" && make doc
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: src/build/html/
force_orphan: true