Skip to content

Test doc bulding

Test doc bulding #163

Workflow file for this run

name: Documentation
on: [push, workflow_dispatch]
defaults:
run:
shell: bash
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
pre-commit:
name: ruff and hooks.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.8'
- uses: pre-commit/[email protected]
with:
extra_args: --all-files --show-diff-on-failure
doc:
name: Documentation
runs-on: ubuntu-latest
if: |
github.event_name == 'push' ||
(github.event_name == 'pull_request' && github.event.pull_request.draft == false)
strategy:
fail-fast: false
matrix:
python-version: ['3.8']
torch-version: ['1.11']
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
lfs: false
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Cache dependency
id: cache-dependencies
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install torch==${{ matrix.torch-version }} --extra-index-url https://download.pytorch.org/whl/cpu
pip install -e .[dev]
- name: Check doc building
run: |
jupyter nbconvert --to markdown tutorials/*.ipynb --output-dir docs/tutorial/
jupyter nbconvert --to markdown examples/*.ipynb --output-dir docs/examples/
mkdocs build -f docs/mkdocs.yml --site-dir site