Skip to content
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.

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

Deploy doc #9

Merged
merged 7 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions .github/workflows/deploy_doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Deploy Documentation

on:
push:
tags:
- '*'
pull_request:
branches:
- main

jobs:
deploy:
runs-on: tps_sco_nv
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Extract tag
id: extract_tag
run: |
echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
echo "BRANCH_NAME=${{ github.head_ref }}" >> $GITHUB_ENV

- name: Build documentation
run: |
set -e
export PYTHONPATH="${PYTHONPATH}:$(pwd)"
cd docs
make clean
make html
cd ..
if [ ! -d "docs/build" ]; then
echo "Build directory does not exist."
exit 1
fi
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ figures:

clean:
@echo "Removing everything under 'build'.."
@rm -r $(BUILDDIR)/html/ $(BUILDDIR)/doctrees
-@rm -r $(BUILDDIR)/html/ $(BUILDDIR)/doctrees