Skip to content

Commit 844b9b9

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

File tree

1 file changed

+62
-22
lines changed

1 file changed

+62
-22
lines changed

.github/workflows/build_docs.yaml

Lines changed: 62 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,16 @@ jobs:
2525
- name: Set up Micromamba
2626
uses: mamba-org/setup-micromamba@v2
2727
with:
28-
micromamba-version: "latest" # Use the latest version of micromamba
28+
micromamba-version: "latest"
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
3433

3534
- name: Install package
36-
# shell: bash -l {0}
3735
run: pip install -e .
3836

3937
- name: Generate Documentation
40-
shell: bash -l {0}
4138
run: pdoc synaptic_reconstruction -o doc/html
4239

4340
- name: Verify Documentation Output
@@ -46,7 +43,7 @@ jobs:
4643
- name: Upload Documentation Artifact
4744
uses: actions/upload-artifact@v3
4845
with:
49-
name: documentation
46+
name: github-pages # Must match the artifact_name in deploy-pages
5047
path: doc/html
5148

5249
deploy:
@@ -56,21 +53,64 @@ jobs:
5653
permissions:
5754
pages: write
5855
id-token: write
59-
environment:
60-
name: github-pages
61-
url: ${{ steps.deployment.outputs.page_url }}
6256
steps:
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: github-pages
71-
# deploy:
72-
# - name: Deploy to GitHub Pages
73-
# uses: peaceiris/actions-gh-pages@v3
74-
# with:
75-
# github_token: ${{ secrets.GITHUB_TOKEN }}
76-
# publish_dir: doc/html
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
116+

0 commit comments

Comments
 (0)