File tree Expand file tree Collapse file tree 1 file changed +50
-0
lines changed Expand file tree Collapse file tree 1 file changed +50
-0
lines changed Original file line number Diff line number Diff line change
1
+ name : website
2
+
3
+ # build the documentation whenever there are new commits on main
4
+ on :
5
+ push :
6
+ branches :
7
+ - main
8
+ # Alternative: only build for tags.
9
+ # tags:
10
+ # - '*'
11
+
12
+ # security: restrict permissions for CI jobs.
13
+ permissions :
14
+ contents : read
15
+
16
+ jobs :
17
+ # Build the documentation and upload the static HTML files as an artifact.
18
+ build :
19
+ runs-on : ubuntu-latest
20
+ steps :
21
+ - uses : actions/checkout@v4
22
+ - uses : actions/setup-python@v5
23
+ with :
24
+ python-version : ' 3.13'
25
+
26
+ # Install dependencies
27
+ - run : pip install -e .
28
+ - run : pip install pdoc
29
+ # Build the documentation
30
+ - run : pdoc src/benlink -o docs --logo /logo.svg
31
+ - run : cp logo.svg docs
32
+
33
+ - uses : actions/upload-pages-artifact@v3
34
+ with :
35
+ path : docs/
36
+
37
+ # Deploy the artifact to GitHub pages.
38
+ # This is a separate job so that only actions/deploy-pages has the necessary permissions.
39
+ deploy :
40
+ needs : build
41
+ runs-on : ubuntu-latest
42
+ permissions :
43
+ pages : write
44
+ id-token : write
45
+ environment :
46
+ name : github-pages
47
+ url : ${{ steps.deployment.outputs.page_url }}
48
+ steps :
49
+ - id : deployment
50
+ uses : actions/deploy-pages@v4
You can’t perform that action at this time.
0 commit comments