python-ipam/.github/workflows/docs.yml at main · tuxpeople/python-ipam · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - '*.md'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

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

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

jobs:
  build:
    name: Build Documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.14'

      - name: Install dependencies
        run: |
          pip install mkdocs mkdocs-material pymdown-extensions

      - name: Create mkdocs.yml if not exists
        run: |
          if [ ! -f mkdocs.yml ]; then
            cat > mkdocs.yml << 'EOF'
          site_name: Python IPAM Documentation
          site_description: Modern IP Address Management System
          site_author: Python IPAM Team
          repo_url: https://github.com/${{ github.repository }}
          repo_name: ${{ github.repository }}

          theme:
            name: material
            palette:
              primary: indigo
              accent: indigo
            features:
              - navigation.tabs
              - navigation.sections
              - navigation.top
              - search.suggest
              - search.highlight
              - content.code.copy

          nav:
            - Home: index.md
            - Features: FEATURES.md
            - API Documentation: API.md
            - Refactoring Notes: REFACTORING.md
            - Development: CLAUDE.md

          markdown_extensions:
            - pymdownx.highlight:
                anchor_linenums: true
            - pymdownx.superfences
            - pymdownx.tabbed:
                alternate_style: true
            - admonition
            - pymdownx.details
            - tables
            - toc:
                permalink: true

          extra:
            version:
              provider: mike
          EOF
          fi

      - name: Prepare docs directory
        run: |
          mkdir -p docs
          cp README.md docs/index.md
          cp FEATURES.md docs/
          cp API.md docs/
          cp REFACTORING.md docs/
          cp CLAUDE.md docs/

      - name: Build documentation
        run: mkdocs build

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

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: 'site'

  deploy:
    name: Deploy to GitHub Pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4