Pointing to actual notebook files in README #5
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: Deploy Docs | |
on: | |
push: | |
branches: [ dev ] | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
name: Generate Website | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
with: | |
submodules: 'recursive' | |
fetch-depth: 0 | |
- name: Update submodules | |
run: | | |
git submodule update --init --recursive --remote | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Install docs dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Install A2Perf | |
run: pip install -e . | |
- name: Build | |
run: sphinx-build -b dirhtml -v docs _build | |
- name: Move 404 | |
run: mv _build/404/index.html _build/404.html | |
- name: Update 404 links | |
run: python docs/_scripts/move_404.py _build/404.html | |
- name: Remove .doctrees | |
run: rm -r _build/.doctrees | |
- name: Upload to GitHub Pages | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
folder: _build |