Merge remote-tracking branch 'origin/main' into finsberg/updates

.github/workflows/build_docs.yml

@@ -2,31 +2,20 @@
 name: Deploy static content to Pages
 
 on:
-  # Runs on pushes targeting the default branch
   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: ./docs/_build/html
+      PUBLISH_DIR: ./_build/html
 
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -77,7 +77,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+_build/
 
 # PyBuilder
 .pybuilder/

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Simula Reaseach Laboratory
+Copyright 2022 Simula Research Laboratory
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,5 +1,5 @@
 # Supplementary code for the paper: Title of paper
-
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/scientificcomputing/example-paper/HEAD)
 
 This repository contains supplementary code for the paper
 > Finsberg, H., Dokken, J. 2022.

_config.yml

@@ -15,8 +15,7 @@ execute:
 # Information about where the book exists on the web
 repository:
   url: https://github.com/scientificcomputing/example-paper # Online location of your book
-  path_to_book: _sources # Optional path to your book, relative to the repository root
-  branch: gh-pages  # Which branch of the repository should be used when creating links (optional)
+  branch: main  # Which branch of the repository should be used when creating links (optional)
 
 launch_buttons:
   notebook_interface: "jupyterlab" # The interface interactive links will activate ["classic", "jupyterlab"]

docker/Dockerfile

@@ -14,7 +14,7 @@ ARG REPO_BRANCH="main"
 
 WORKDIR /repo
 
-# Copy pyproject.toml first so that we done need to reinstall in case anoter file
-# is changing ater rebuiding docker image
+# Copy pyproject.toml first so that we done need to reinstall in case another file
+# is changing after rebuiding docker image
 RUN git clone --branch ${REPO_BRANCH} --single-branch https://github.com/scientificcomputing/example-paper.git
-RUN cd example-paper && python3 -m pip install pip --upgrade && python3 -m pip install --no-cache-dir -r requirements.txt && rm -rf /tmp
+RUN cd example-paper && python3 -m pip install --no-cache-dir -r requirements.txt && rm -rf /tmp