ghostfolio-py/.github/workflows/docs.yml at main · ms32035/ghostfolio-py · 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
name: Generate and Deploy Documentation

on:
  push:
    branches: [main, master]
  pull_request:
    branches: [main, master]
  workflow_dispatch:

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

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

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.11"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install pdoc3 requests

      - name: Generate documentation
        run: |
          pdoc --html --output-dir docs ghostfolio
          # Create index.html that redirects to the main module
          echo '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0; url=ghostfolio/index.html"></head><body><p>Redirecting to <a href="ghostfolio/index.html">documentation</a>...</p></body></html>' > docs/index.html

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs

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