Skip to content

WIP: Add flexray support via vector xllib #1659

WIP: Add flexray support via vector xllib

WIP: Add flexray support via vector xllib #1659

Workflow file for this run

# SPDX-FileCopyrightText: AISEC Pentesting Team
#
# SPDX-License-Identifier: CC0-1.0
# https://github.com/actions/setup-python/issues/374
name: docs
on:
push:
branches:
- master
pull_request:
paths:
- 'pyproject.toml'
- 'poetry.lock'
- '.github/**'
- 'docs/**'
- 'src/**'
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- uses: Gr1N/setup-poetry@v9
- uses: actions/cache@v4
with:
path: ~/.cache/pypoetry/virtualenvs
key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
- name: Install Dependencies
run: |
poetry install
- name: Invoke sphinx-build
run: |
poetry run make -C docs SPHINXOPTS="-W" html
- name: Archive webpage
uses: actions/upload-artifact@v4
with:
path: |
docs/_build/html
deploy-docs:
runs-on: ubuntu-latest
needs: build-docs
if: github.ref == 'refs/heads/master'
steps:
- uses: Gr1N/setup-poetry@v9
- uses: actions/cache@v4
with:
path: ~/.cache/pypoetry/virtualenvs
key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
- name: Download all workflow run artifacts
uses: actions/download-artifact@v4
- name: Deploy docs to Github Pages
uses: crazy-max/ghaction-github-pages@v4
with:
target_branch: gh-pages
build_dir: artifact
jekyll: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}