netom/.github/workflows/docs.yml at main · FastNetMon/netom · 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
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'etc/netom.conf'
      - 'Cargo.toml'
      - 'pkg/check-build-sources.py'
      - '.github/workflows/docs.yml'
  pull_request:
    paths:
      - 'docs/**'
      - 'etc/netom.conf'
      - 'Cargo.toml'
      - 'pkg/check-build-sources.py'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  build:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false
      - uses: actions/setup-python@v7
        with:
          python-version: '3.13'
          cache: pip
          cache-dependency-path: docs/requirements.txt
      - name: Check build sources
        run: python pkg/check-build-sources.py
      - name: Install documentation tools
        run: python -m pip install -r docs/requirements.txt
      - name: Build the manual
        run: python -m sphinx -n -W --keep-going -b html docs docs/_build/html
      - uses: actions/upload-pages-artifact@v4
        if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
        with:
          path: docs/_build/html

  deploy:
    if: github.repository == 'FastNetMon/netom' && github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-24.04
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/configure-pages@v5
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4