Create build_docs.yml #1
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: build_docs | |
on: [push, pull_request, workflow_dispatch] | |
permissions: | |
contents: write | |
jobs: | |
build_docs: | |
runs-on: ubuntu-latest | |
env: | |
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v3 | |
- name: Install dependencies | |
run: | | |
pip install sphinx sphinx_rtd_theme myst_parser | |
- name: Sphinx build | |
run: | | |
cd docs | |
make clean | |
make html | |
cd _build | |
touch .nojekyll | |
git init | |
git add -A | |
git config --local user.email "[email protected]" | |
git config --local useer.name "GitHub Action" | |
git commit -m 'deploy' | |
- name: Deploy to GitHub Pages, force push to destination branch | |
uses: ad-m/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_branch: gh-pages | |
publish_dir: ./docs/_build/html | |
force: true | |
force_orphan: true |