Skip to content

Review: Add tutorials infrastructure AND Clean namings + flake8 + code style #35

Review: Add tutorials infrastructure AND Clean namings + flake8 + code style

Review: Add tutorials infrastructure AND Clean namings + flake8 + code style #35

Workflow file for this run

name: "Docs: Check and Deploy"
on:
push:
branches: [main, github-actions-test]
pull_request:
branches: [main]
permissions:
contents: write
jobs:
build:
runs-on: ${{matrix.os}}
strategy:
matrix:
os: [ubuntu-latest]
python-version: [3.10.11]
steps:
- uses: actions/checkout@v3
- name: Build using Python ${{matrix.python-version}}
uses: actions/setup-python@v4
with:
python-version: ${{matrix.python-version}}
cache: "pip"
cache-dependency-path: "pyproject.toml"
- name: Install dependencies [pip]
run: |
pip install --upgrade pip setuptools wheel
pip install -e .[doc]
- name: Install Pandoc [apt-get]
run: |
sudo apt-get -y install pandoc
- name: Generate Docs [Sphinx]
run: |
sphinx-build -b html -D version=latest -D release=latest docs docs/_build
- name: Deploy Docs
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: main
folder: docs/_build
token: ${{ secrets.DOCUMENTATION_KEY }}
repository-name: pyt-team/pyt-team.github.io
target-folder: topoembedx
clean: true