Skip to content

Commit da0f15d

Browse files
committed
Fix location of docs artifact
1 parent 4856484 commit da0f15d

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,41 @@ jobs:
66
build:
77
name: Build Docs
88
runs-on: ubuntu-latest
9+
# We only execute this step if the commit is tagged, i.e., this is a release
10+
#if: startsWith(github.ref, 'refs/tags')
911
steps:
1012
- name: Checkout code
1113
uses: actions/checkout@master
1214
- name: Build docs
1315
uses: actions/setup-python@master
1416
with:
1517
python-version: "3.12"
16-
- run: |
18+
# We *need* to install projectq to generate documentation
19+
# This is needed because sphinx analyzes SimulaQron's code to generate the HTML;
20+
# this implies that the modules are imported (but not executed), which therefore
21+
# imports projectq classes.
22+
- name: Install simulaqron and build docs
23+
run: |
1724
make install-optional
1825
cd docs
1926
make install-deps
2027
make build
2128
- name: Upload static files as artifact
22-
# We only execute this step if the commit is tagged, i.e., this is a release
23-
#if: startsWith(github.ref, 'refs/tags')
2429
id: deployment
2530
uses: actions/upload-pages-artifact@v4
2631
with:
27-
path: build/html/
32+
path: docs/build/html/
2833

2934
deploy:
3035
name: Deploy docs
3136
needs: build
3237
runs-on: ubuntu-latest
38+
# We only execute this step if the commit is tagged, i.e., this is a release
39+
#if: startsWith(github.ref, 'refs/tags')
3340
environment:
3441
name: github-pages
3542
url: ${{ steps.deployment.outputs.page_url }}
3643
steps:
3744
- name: Deploy to GitHub Pages
38-
# We only execute this step if the commit is tagged, i.e., this is a release
39-
#if: startsWith(github.ref, 'refs/tags')
4045
id: deployment
4146
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)