1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
|
name: Documentation
on:
push:
branches-ignore:
- 'dependabot/**'
- 'gh-pages'
tags:
- "[0-9]+.[0-9]+.[0-9]+" # Canonical versioned tags
- "[0-9]+.[0-9]+.[0-9]+.post[0-9]+" # Canonical rebuild tags
pull_request:
branches-ignore:
- 'dependabot/**'
- 'gh-pages'
paths:
- "docs/**"
- "README.rst"
- "urwid/**"
- "pyproject.toml"
- ".github/workflows/documentation.yml"
jobs:
Build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0 # need for setuptools_scm
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.x'
cache: 'pip'
- name: Install Ubuntu dependencies
run: |
sudo apt-get -qq update
sudo apt-get install -y python3-dev python3-gi python3-gi-cairo
sudo apt-get install -y gobject-introspection libgirepository-2.0-dev libcairo2-dev
- name: Install python dependencies
run: |
pip install -U -r test_requirements.txt PyGObject
pip install -U sphinx
- name: Install main package
run: pip install -e .
- name: Build documentation
run: sphinx-build docs build/documentation
- uses: actions/upload-artifact@v5
with:
path: build/documentation
name: documentation
|