Skip to content

Commit ba25763

Browse files
authored
Update build_docs.yaml
1 parent 844b9b9 commit ba25763

File tree

1 file changed

+16
-61
lines changed

1 file changed

+16
-61
lines changed

.github/workflows/build_docs.yaml

Lines changed: 16 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,19 @@ jobs:
2525
- name: Set up Micromamba
2626
uses: mamba-org/setup-micromamba@v2
2727
with:
28-
micromamba-version: "latest"
28+
micromamba-version: "latest" # Use the latest version of micromamba
2929
environment-file: .github/doc_env.yaml # Reference your environment.yml file
3030
init-shell: bash
3131
cache-environment: true
3232
post-cleanup: 'all'
33+
# cache: true # Cache the micromamba environment
3334

3435
- name: Install package
36+
# shell: bash -l {0}
3537
run: pip install -e .
3638

3739
- name: Generate Documentation
40+
shell: bash -l {0}
3841
run: pdoc synaptic_reconstruction -o doc/html
3942

4043
- name: Verify Documentation Output
@@ -43,7 +46,7 @@ jobs:
4346
- name: Upload Documentation Artifact
4447
uses: actions/upload-artifact@v3
4548
with:
46-
name: github-pages # Must match the artifact_name in deploy-pages
49+
name: documentation
4750
path: doc/html
4851

4952
deploy:
@@ -53,64 +56,16 @@ jobs:
5356
permissions:
5457
pages: write
5558
id-token: write
59+
environment:
60+
name: github-pages
61+
url: ${{ steps.deployment.outputs.page_url }}
5662
steps:
57-
- name: Deploy to GitHub Pages
58-
uses: actions/deploy-pages@v2
59-
with:
60-
artifact_name: github-pages
61-
# jobs:
62-
# build:
63-
# name: Build Documentation
64-
# runs-on: ubuntu-latest
65-
66-
# steps:
67-
# - name: Checkout Code
68-
# uses: actions/checkout@v3
69-
70-
# - name: Set up Micromamba
71-
# uses: mamba-org/setup-micromamba@v2
72-
# with:
73-
# micromamba-version: "latest" # Use the latest version of micromamba
74-
# environment-file: .github/doc_env.yaml # Reference your environment.yml file
75-
# init-shell: bash
76-
# cache-environment: true
77-
# post-cleanup: 'all'
78-
# # cache: true # Cache the micromamba environment
79-
80-
# - name: Install package
81-
# # shell: bash -l {0}
82-
# run: pip install -e .
83-
84-
# - name: Generate Documentation
85-
# shell: bash -l {0}
86-
# run: pdoc synaptic_reconstruction -o doc/html
87-
88-
# - name: Verify Documentation Output
89-
# run: ls -la doc/html
90-
91-
# - name: Upload Documentation Artifact
92-
# uses: actions/upload-artifact@v3
93-
# with:
94-
# name: documentation
95-
# path: doc/html
96-
97-
# deploy:
98-
# name: Deploy Documentation
99-
# needs: build
100-
# runs-on: ubuntu-latest
101-
# permissions:
102-
# pages: write
103-
# id-token: write
104-
# environment:
105-
# name: github-pages
106-
# url: ${{ steps.deployment.outputs.page_url }}
107-
# steps:
108-
# - name: Download Documentation Artifact
109-
# uses: actions/download-artifact@v3
110-
# with:
111-
# name: documentation
112-
# - name: Deploy to GiHub Pages
113-
# uses: actions/deploy-pages@v2
114-
# with:
115-
# artifact_name: github-pages
63+
- name: Download Documentation Artifact
64+
uses: actions/download-artifact@v3
65+
with:
66+
name: documentation
67+
- name: Deploy to GiHub Pages
68+
uses: actions/deploy-pages@v2
69+
with:
70+
artifact_name: documentation
11671

0 commit comments

Comments
 (0)