gitcraft 0.1.123

A template project for GitHub-related utilities.
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

# GitHub Actions Workflow:  Build documentation using MkDocs.

name: Build Documentation with MkDocs
on:
  push:
    paths:
      - 'docs/**'                          # Trigger on documentation changes
      - '.github/workflows/build-docs-mkdocs.yml' # Trigger on workflow file changes
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/build-docs-mkdocs.yml'

jobs:
  build-docs:
    runs-on: ubuntu-latest

    steps:
      # Checkout repository code
      - name: Checkout code
        uses: actions/checkout@v4

      # Set up Python environment
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      # Install MkDocs
      - name: Install MkDocs
        run: |
          pip install mkdocs

      # Build documentation
      - name: Build documentation
        run: mkdocs build