This repository was archived by the owner on Feb 7, 2025. It is now read-only.
File tree 1 file changed +55
-0
lines changed
1 file changed +55
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Combination of https://github.com/RobinMagnet/pyFM/blob/master/.github/workflows/documentation.yml
2
+ # and https://github.com/r-lib/pkgdown/blob/main/.github/workflows/pkgdown.yaml
3
+ name : docs
4
+
5
+ on :
6
+ push :
7
+ branches : [main]
8
+ pull_request :
9
+ branches : [main]
10
+ release :
11
+ types : [published]
12
+ workflow_dispatch :
13
+
14
+ jobs :
15
+ build_documentation :
16
+ name : Build Documentation
17
+ runs-on : ubuntu-latest
18
+
19
+ permissions :
20
+ contents : write
21
+
22
+ steps :
23
+ - name : Checkout repository
24
+ uses : actions/checkout@v4
25
+ with :
26
+ submodules : ' recursive'
27
+
28
+ - name : Setup Python 3.10
29
+ uses : actions/setup-python@v5
30
+ with :
31
+ python-version : " 3.10"
32
+ cache : " pip"
33
+
34
+ - name : Install Package with Relevant Dependencies
35
+ run : |
36
+ pip install --upgrade pip
37
+ pip install -r docs/requirements.txt
38
+ pip install .
39
+
40
+ - name : Build HTML
41
+ run : |
42
+ sphinx-build -M html docs/source/ docs/_build/
43
+
44
+ - name : Upload Artifact
45
+ uses : actions/upload-artifact@v4
46
+ with :
47
+ path :
48
+ docs/_build/html/
49
+
50
+ - name : Deploy to GitHub Pages
51
+ uses : peaceiris/actions-gh-pages@v4
52
+ if : github.ref == 'refs/heads/main'
53
+ with :
54
+ github_token : ${{ secrets.GITHUB_TOKEN }}
55
+ publish_dir : docs/_build/html
You can’t perform that action at this time.
0 commit comments