den2obj/.github/workflows/docs.yml at master · ifilot/den2obj · 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
name: Documentation

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

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

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build Sphinx Documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.13"

    - name: Install Dependencies
      run: |
        python -m pip install --upgrade pip
        pip install sphinx-rtd-theme \
              sphinxcontrib-tikz \
              pydata-sphinx-theme \
              sphinx_design \
              sphinx_subfigure \
              myst_parser

    - name: Build Documentation
      run: |
        cd docs
        make html

    - name: Configure GitHub Pages
      if: github.event_name == 'push'
      uses: actions/configure-pages@v5

    - name: Upload GitHub Pages artifact
      if: github.event_name == 'push'
      uses: actions/upload-pages-artifact@v3
      with:
        path: docs/_build/html

  deploy:
    name: Deploy GitHub Pages
    if: github.event_name == 'push'
    needs: build
    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@v4