Skip to content
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
51 changes: 10 additions & 41 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,16 @@
name: Github Pages

on:
push:
branches:
- "**"
pull_request:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

workflow_call:

jobs:
build:
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
# Directory that will be published on github pages
PUBLISH_DIR: ./_build/html
Expand All @@ -40,29 +28,10 @@ jobs:

- name: Build docs
run: jupyter book build .

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
- name: Upload documentation as artifact
uses: actions/upload-artifact@v3
with:
name: documentation
path: ${{ env.PUBLISH_DIR }}


# Single deploy job since we're just deploying
deploy:
if: github.ref == 'refs/heads/main'
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup Pages
uses: actions/configure-pages@v2

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
if-no-files-found: error
54 changes: 54 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Deploy to Github pages

on:
push:
branches: [main]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:


# Build documentation/website. Will be downloaded in first step
build-docs:
uses: ./.github/workflows/build_docs.yml

deploy:
needs: [build-docs]

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Download docs artifact
# docs artifact is uploaded by build-docs job
uses: actions/download-artifact@v3
with:
name: documentation
path: "./public"

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: "./public"

- name: Checkout repository
uses: actions/checkout@v3

- name: Setup Pages
uses: actions/configure-pages@v3

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
4 changes: 2 additions & 2 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ jobs:

- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
uses: docker/metadata-action@v4
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

- name: Build and push Docker image
uses: docker/build-push-action@v3
uses: docker/build-push-action@v4
with:
context: .
push: true
Expand Down
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ parse:
sphinx:
config:
bibtex_bibfiles: ["docs/refs.bib"]
html_last_updated_fmt: "%b %d, %Y"

extra_extensions:
- 'sphinx.ext.autodoc'
Expand Down
Binary file modified docs/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.