diff --git a/.github/workflows/deploy_sphinx_docs.yml b/.github/workflows/deploy_sphinx_docs.yml new file mode 100644 index 00000000..d1918737 --- /dev/null +++ b/.github/workflows/deploy_sphinx_docs.yml @@ -0,0 +1,40 @@ +name: Deploy Sphinx documentation to Pages + +on: + pull_request: + types: [opened, synchronize] + paths: + - 'docs/sphinx_doc/**/*' + push: + branches: + - main + +jobs: + pages: + runs-on: ubuntu-20.04 + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Python ${{ matrix.python-version }} + uses: actions/setup-python@master + with: + python_version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r docs/sphinx_doc/requirements.txt + - id: build + name: Build Documentation + run: | + cd docs/sphinx_doc + bash build_sphinx_doc.sh + - name: Upload Documentation + uses: actions/upload-artifact@v3 + with: + name: SphinxDoc + path: 'docs/sphinx_doc/build/html' + - uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: 'docs/sphinx_doc/build/html'