Skip to content

Commit a0ac442

Browse files
committed
Add documentation to a separate route on the website.
1 parent aafeac2 commit a0ac442

File tree

3 files changed

+22
-70
lines changed

3 files changed

+22
-70
lines changed

.github/workflows/analysis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,4 @@ jobs:
170170
name: Comparison
171171
path: |
172172
test_reference.csv
173-
test_results.csv
173+
test_results.csv

.github/workflows/documentation.yml

Lines changed: 0 additions & 66 deletions
This file was deleted.

.github/workflows/website.yml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy dashboard website
1+
name: Build & Deploy Website
22

33
on:
44
workflow_run:
@@ -33,8 +33,14 @@ jobs:
3333
run: |
3434
pip install -r requirements.txt
3535
36-
# Action to download artifacts from a different workflow (analysis.yml)
36+
# Action Figures artifact
3737
- name: 'Download artifact'
38+
if: ${{ github.event.workflow_run.conclusion == 'success' }}
39+
uses: ./.github/actions/download-artifact
40+
with:
41+
name: 'Figures'
42+
# Action analysis data artifact
43+
- name: 'Download analysis data'
3844
if: ${{ github.event.workflow_run.conclusion == 'success' }}
3945
uses: ./.github/actions/download-artifact
4046
with:
@@ -44,7 +50,19 @@ jobs:
4450
run: |
4551
mv test_output.csv website/
4652
47-
- name: Upload website artifact
53+
- name: Build documentation
54+
run: |
55+
mkdir docs/_static
56+
mv *.pdf docs/_static/
57+
sphinx-apidoc -o docs src
58+
cd docs/
59+
make html
60+
61+
- name: move data to the website folder
62+
run: |
63+
mv docs/_build/html website/documentation
64+
65+
- name: Upload docs artifact
4866
uses: actions/upload-pages-artifact@v3
4967
with:
5068
path: 'website'

0 commit comments

Comments
 (0)