sympde/.github/workflows/documentation.yml at master · pyccel/sympde · GitHub

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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
name: Documentation

on:
  push:
    branches: [ master ]
    paths:
      - 'README.md'
      - 'doc/**'
      - 'sympde/**.py'
      - 'pyproject.toml'
      - '.github/workflows/documentation.yml'

  pull_request:
    branches: [ master ]
    types:
      - opened
      - reopened
      - synchronize
      - ready_for_review

  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build_docs:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v6

    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: '3.10'
        cache: 'pip'
        cache-dependency-path: |
          pyproject.toml

    - name: Upgrade pip, setuptools, and wheel
      run: |
        pip install --upgrade pip setuptools wheel

    - name: Install Graphviz
      run: |
        sudo apt-get update
        sudo apt-get install --yes graphviz

    - name: Install project and documentation dependencies
      run: |
        pip install .[docs]
        pip freeze

    - name: Run documentation examples
      run: |
        for example in doc/examples/*.py; do
          python "$example"
        done

    - name: Make the Sphinx documentation
      run: >-
        python -m sphinx -W --keep-going
        -b html doc doc/_build/html

    - name: Setup Pages
      uses: actions/configure-pages@v6

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v5
      with:
        path: 'doc/_build/html'

  deploy_docs:
    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
    needs: build_docs
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v5