Skip to content

Update README.md

Update README.md #24

Workflow file for this run

name: Docs
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.9]
steps:
- name: Checkout Source
uses: actions/[email protected]
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
sudo apt install pandoc
python -m pip install --upgrade pip
pip install jaxlib
pip install -r requirements/requirements-core.txt
pip install -r requirements/requirements-docs.txt
pip install .
- name: Build Documentation
run: |
cd docs && make html
- name: Deploy
if: github.ref == 'refs/heads/main'
uses: JamesIves/[email protected]
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs/_build/html # The folder the action should deploy.