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
|
name: Build and Deploy Documentation
on: [push, pull_request]
jobs:
Build:
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install Dependencies Ubuntu
run: |
sudo apt-get update
sudo apt install -y python3-dev python3 build-essential graphviz
sudo python3 -m pip install ford
- name: Build Developer Documenation
run: |
ford ford.md
- name: Upload Documentation
uses: actions/upload-artifact@v4
with:
name: documentation
path: doc/html
if-no-files-found: error
- name: Broken Link Check
if: ${{ github.ref == 'refs/heads/main'}}
uses: technote-space/broken-link-checker-action@v1
with:
TARGET: file://${{ github.workspace }}/doc/html/index.html
RECURSIVE: true
ASSIGNEES: ${{ github.actor }}
- name: Deploy API Documentation
uses: JamesIves/github-pages-deploy-action@4.1.0
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
branch: gh-pages
folder: doc/html
|
