Skip to content

Merge pull request #91 from dengzq1234/main #2

Merge pull request #91 from dengzq1234/main

Merge pull request #91 from dengzq1234/main #2

Workflow file for this run

name: Deploy Sphinx docs to GitHub Pages
on:
push:
branches:
- main
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Check out the code
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-rtd-theme
- name: Build the documentation
run: make html
working-directory: ./docs
- name: Post-process HTML files
run: python post_process_html.py
working-directory: ./docs
- name: Deploy to GitHub Pages
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
run: |
cd docs/build/html
git init
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
git add .
git commit -m "Deploy documentation"
git push --force --quiet "https://${{ secrets.ACTIONS_DEPLOY_KEY }}@github.com/${{ github.repository }}.git" master:gh-pages