Skip to content

🎨 publish report to GitHub Pages #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2025
Merged

🎨 publish report to GitHub Pages #51

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44b218f
:art: publish report to gh_pages branch
enryH Jan 31, 2025
b5a5243
:art: test to only publish new report upon new release
enryH Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test documentation building (until it's moved to ReadTheDocs)
name: Test documentation building, and publish report to GitHub Pages

on:
push:
Expand Down Expand Up @@ -35,6 +35,16 @@ jobs:
run: |
cd docs
sphinx-build -n --keep-going -b html ./ ./_build/
- name: Rename entry point of report to index.html
run: |
mv docs/quarto_report/quarto_report.html docs/quarto_report/index.html
- name: Publish html report to github pages
# Only publish a new static report upon a new release -> can be changed.
if: startsWith(github.ref, 'refs/tags')
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/quarto_report/
# - name: save artifacts
# uses: actions/upload-artifact@v4
# with:
Expand Down