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: Generate Docs | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Set up Python 🐍 | |
uses: actions/setup-python@v4 | |
- name: Checkout 🛎️ | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo | |
# - name: Run Pre-Commit Tests 🧪 | |
# uses: pre-commit/[email protected] | |
- name: Install dependencies 🔧 | |
run: pip3 install sphinx sphinxawesome-theme sphinx-sitemap myst-parser | |
- name: Build Documentation 🧱 | |
uses: sphinx-notes/pages@v3 | |
with: | |
checkout: false | |
publish: false | |
- name: Push changes 📌 | |
uses: ad-m/github-push-action@master | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
branch: pages | |
force: true |