Skip to content

Commit 05d8437

Browse files
🚧 Add preliminary workflow for building docs
1 parent e529ebb commit 05d8437

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,3 +254,44 @@ jobs:
254254
echo -e '```\n' >> $GITHUB_STEP_SUMMARY
255255
(cd output/wheel && tree -a * | sed 's/^/ /' | tee -a $GITHUB_STEP_SUMMARY)
256256
echo -e '\n```\n' >> $GITHUB_STEP_SUMMARY
257+
258+
# FIXME: when ready, move this to a separate workflow or make it run on
259+
# just the main branch (after a PR is merged)
260+
docs:
261+
needs: [style]
262+
name: documentation-build
263+
runs-on: ubuntu-latest
264+
permissions:
265+
contents: write
266+
steps:
267+
- uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
268+
with:
269+
fetch-depth: 0
270+
submodules: 'recursive'
271+
- uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
272+
with:
273+
go-version: "1.22.1"
274+
cache: false
275+
check-latest: true
276+
- uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
277+
with:
278+
python-version: 3.12
279+
280+
- name: Install Hugo
281+
run: pip install -e .
282+
283+
# TODO: refactor to use nox or just remove nox later
284+
- name: Build documentation website
285+
run: |
286+
cd docs
287+
hugo --minify
288+
289+
- name: Deploy documentation website
290+
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
291+
with:
292+
github_token: ${{ secrets.GITHUB_TOKEN }}
293+
publish_dir: ./docs/public/
294+
publish_branch: gh-pages
295+
user_name: "agriyakhetarpal"
296+
user_email: "74401230+agriyakhetarpal@users.noreply.github.com"
297+
keep_files: false

0 commit comments

Comments
 (0)