Skip to content

Deploy Sphinx documentation to Pages #93

Deploy Sphinx documentation to Pages

Deploy Sphinx documentation to Pages #93

Workflow file for this run

name: Deploy Sphinx documentation to Pages
on:
pull_request_review:
types: [submitted]
pull_request:
types: [synchronize]
jobs:
check-approval-and-run-script:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Check for approval
id: check_approval
run: |
approvals=$(gh pr review ${{ github.event.pull_request.number }} --json reviewState --jq '.[] | select(.reviewState == "APPROVED")' | wc -l)
if [ "$approvals" -lt 1 ]; then
echo "No approvals yet."
exit 1
fi
build_tutorial:
needs: check-approval-and-run-script
timeout-minutes: 20
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
python-version: ['3.9']
env:
OS: ${{ matrix.os }}
PYTHON: '3.9'
steps:
- uses: actions/checkout@master
- name: Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@master
with:
python-version: ${{ matrix.python-version }}
- name: Update setuptools
run: |
pip install setuptools==68.2.2 wheel==0.41.2
- name: Install Dependencies
run: |
pip install -q -e .[full]
- id: build
name: Build Documentation
run: |
cd docs/sphinx_doc
./build_sphinx_doc.sh
- name: Upload Documentation
uses: actions/upload-artifact@v4
with:
name: SphinxDoc
path: 'docs/sphinx_doc/build'
- 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'
cname: doc.agentscope.io