Skip to content

Commit f3b7b8a

Browse files
committed
Updates documentation build process
1 parent 0f54db5 commit f3b7b8a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

.github/workflows/build-docs.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ jobs:
9898
9999
# Copy Jupyter notebooks from the project to the docs folder
100100
# The notebooks are used to generate the documentation
101-
- name: Convert .py from ${{ env.NOTEBOOKS_DIR }}/ to Jupyter notebooks and add to docs/${{env.NOTEBOOKS_DIR }}/
101+
- name: Convert ${{ env.NOTEBOOKS_DIR }}/*.py to docs/${{env.NOTEBOOKS_DIR }}/*.ipynb
102102
run: |
103103
jupytext ${{ env.NOTEBOOKS_DIR }}/*.py --to ipynb
104104
mv ${{ env.NOTEBOOKS_DIR }}/*.ipynb docs/${{ env.NOTEBOOKS_DIR }}/
@@ -128,7 +128,7 @@ jobs:
128128
129129
# Set up the Pages action to configure the static files to be deployed
130130
# NOTE: The repository must have GitHub Pages enabled and configured to build using GitHub Actions
131-
# This can be done via https://github.com/easyscience/EasyDiffractionLib/settings/pages
131+
# This can be done via https://github.com/easyscience/diffraction-lib/settings/pages
132132
# Select: Build and deploy - Source - GitHub Actions
133133
- name: Setup GitHub Pages
134134
uses: actions/configure-pages@v5
@@ -184,10 +184,10 @@ jobs:
184184
# Deploy the static files created in the previous job to GitHub Pages
185185
# To allow the deployment of the static files to GitHub Pages, no
186186
# restrictions on the branch name need to be set for desired branches on
187-
# https://github.com/easyscience/EasyDiffractionLib/settings/environments
187+
# https://github.com/easyscience/diffraction-lib/settings/environments
188188
# Currently, only develop and master branches are allowed to deploy to GitHub Pages
189-
# Deployed pages are available at https://easyscience.github.io/EasyDiffractionLib
190-
- name: Deploy to easyscience.github.io/EasyDiffractionLib (all branches)
189+
# Deployed pages are available at https://easyscience.github.io/diffraction-lib
190+
- name: Deploy to easyscience.github.io/diffraction-lib (all branches)
191191
uses: actions/deploy-pages@v4
192192

193193
# Download built site as artifact from a previous job for gh_pages (master branch)
@@ -201,10 +201,10 @@ jobs:
201201
# Push the site files created in the previous job to the gh_pages branch
202202
# To be able to push to the gh_pages branch, the personal GitHub API access
203203
# token GH_API_PERSONAL_ACCSESS_TOKEN must be set for this repository via
204-
# https://github.com/easyscience/EasyDiffractionLib/settings/secrets/actions
204+
# https://github.com/easyscience/diffraction-lib/settings/secrets/actions
205205
# This branch is used to deploy the site to the custom domain.
206206
# Deploying is done with a webhook:
207-
# https://github.com/easyscience/EasyDiffractionLib/settings/hooks
207+
# https://github.com/easyscience/diffraction-lib/settings/hooks
208208
# This is done for the gh_pages branch when the site is tested with a step above
209209
- name:
210210
Deploy to gh_pages branch to trigger deployment to custom domain (master branch)

0 commit comments

Comments
 (0)