mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 17:46:19 +00:00
David Lechner
06e01e5ac8
MathJax uses a CDN to to distribute the package. So in order to use the docs offline, we would have to include our own copy. But it is a bit large (50-ish MB), so it is easier to use sphinx.ext.imgmath instead to generate svg images. The situation might be different with MathJax v3, but that requires Sphinx v4.
44 lines
1.3 KiB
YAML
44 lines
1.3 KiB
YAML
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
|
|
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
|
|
|
|
name: Python package
|
|
|
|
on: [ push, pull_request ]
|
|
|
|
jobs:
|
|
build:
|
|
|
|
runs-on: ubuntu-20.04
|
|
strategy:
|
|
matrix:
|
|
python-version: [3.8, 3.9]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
with:
|
|
submodules: recursive
|
|
- name: Set up Python ${{ matrix.python-version }}
|
|
uses: actions/setup-python@v1
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
- name: Install dependencies
|
|
run: |
|
|
pip install poetry
|
|
poetry run python -m pip install --upgrade pip
|
|
poetry run python -m pip install --upgrade setuptools
|
|
poetry install
|
|
- name: Lint Python code
|
|
run: poetry run flake8
|
|
- name: Build package
|
|
run: poetry build
|
|
- name: Lint docs
|
|
run: poetry run doc8
|
|
- name: Build html docs for Read the Docs
|
|
run: poetry run make -C doc html
|
|
- name: Instal IDE docs dependencies
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install dvisvgm preview-latex-style texlive texlive-fonts-extra texlive-latex-extra
|
|
- name: Build html docs for Pybricks Code IDE
|
|
run: poetry run make -C doc html SOURCEDIR=ide
|