Skip to content

Documentation Refactor #1929

Documentation Refactor

Documentation Refactor #1929

Workflow file for this run

name: CI
on:
push:
branches:
- main
- stable
- v*.*.*
tags:
- v*
pull_request:
workflow_dispatch:
jobs:
tests:
name: ${{ matrix.name }}
runs-on: ${{ matrix.os }}
timeout-minutes: 30
strategy:
fail-fast: false
matrix:
include:
- name: Tests, Python 3.12, Windows
os: windows-latest
noxenv: tests-3.12
python: '3.12'
noxposargs: --durations=10
- name: Tests, Python 3.11, Windows
os: windows-latest
noxenv: tests-3.11
python: '3.11'
noxposargs: --durations=10
- name: Tests, Python 3.10, macOS
os: macos-latest
noxenv: tests-3.10
python: '3.10'
- name: Tests, Python 3.10, Linux
os: ubuntu-latest
noxenv: tests-3.10
python: '3.10'
- name: Import XRTpy, Python 3.10, Linux
os: ubuntu-latest
python: '3.10'
noxenv: import_package
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python }}
- name: Install nox
run: python -m pip install --progress-bar off --upgrade nox
- name: ${{ matrix.name }}
run: nox -s ${{ matrix.noxenv }} -- ${{ matrix.noxposargs }}
documentation:
name: ${{ matrix.name }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include:
- name: Documentation
python: '3.12'
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Install nox
run: python -m pip install --progress-bar off --upgrade nox
- name: Install graphviz
run: sudo apt install graphviz
- name: Build documentation
run: nox -s build_docs_nitpicky -- -q