Skip to content

[WIP] Docs V1 (#44)

[WIP] Docs V1 (#44) #9

Workflow file for this run

name: Build the documentation
on:
push:
branches:
- main
permissions:
contents: write
jobs:
build-docs:
concurrency: ci-${{ github.ref }}
name: Build docs (${{ matrix.python-version }}, ${{ matrix.os }})
runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash -l {0}
strategy:
matrix:
os: ["ubuntu-latest"]
python-version: ["3.10"]
steps:
# Grap the latest commit from the branch
- name: Checkout the branch
uses: actions/[email protected]
with:
persist-credentials: false
# Create a virtual environment
- name: create Conda environment
uses: conda-incubator/setup-miniconda@v2
with:
auto-update-conda: true
python-version: ${{ matrix.python-version }}
# Install katex for math support
- name: Install NPM
uses: actions/setup-node@v3
with:
node-version: 16
- name: Install KaTeX
run: |
npm install katex
# Install Poetry and build the documentation
- name: Install and configure Poetry
uses: snok/install-poetry@v1
with:
version: 1.2.2
virtualenvs-create: false
virtualenvs-in-project: false
installer-parallel: true
- name: Install LaTex
run: |
sudo apt-get update
sudo apt-get install texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra dvipng cm-super
- name: Build the documentation with MKDocs
run: |
cp docs/examples/gpjax.mplstyle .
poetry install --all-extras --with docs
conda install pandoc
poetry run mkdocs build
- name: Deploy Page 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: site