fixups for website (#528) #76
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 and deploy" | |
on: | |
push: | |
branches: | |
- main | |
release: | |
types: [ published ] | |
jobs: | |
docs: | |
name: Build Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
lfs: false | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.10' | |
- name: Cache dependency | |
id: cache-dependencies | |
uses: actions/cache@v4 | |
with: | |
path: ~/.cache/pip | |
key: ${{ runner.os }}-pip | |
- name: Install jaxley and dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install .[doc] | |
- name: convert notebooks to markdown | |
run: | | |
cd mkdocs | |
jupyter nbconvert --to markdown ../docs/tutorials/*.ipynb --output-dir docs/tutorial/ | |
- name: Configure Git user for bot | |
run: | | |
git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
git config --local user.name "github-actions[bot]" | |
- name: Build and deploy dev documentation upon push to main | |
if: ${{ github.event_name == 'push' }} | |
run: | | |
cd mkdocs | |
mike deploy dev --push | |
- name: Build and deploy the lastest documentation upon new release | |
if: ${{ github.event_name == 'release' }} | |
run: | | |
cd mkdocs | |
mike deploy ${{ github.event.release.name }} latest -u --push |