Skip to content

Commit c422240

Browse files
authored
Move tutorial notebooks hosting to TrixiDocumentation (#2407)
* Remove CacheNotebooks GHA action * Redirect tutorial links and add Colab
1 parent 5acf73a commit c422240

File tree

2 files changed

+7
-53
lines changed

2 files changed

+7
-53
lines changed

.github/workflows/CacheNotebooks.yml

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/literate/make.jl

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,18 @@ function create_files(title, file, repo_src, pages_dir, notebooks_dir; folder =
1212
binder_logo = "https://mybinder.org/badge_logo.svg"
1313
nbviewer_logo = "https://img.shields.io/badge/render-nbviewer-f37726"
1414
raw_notebook_logo = "https://img.shields.io/badge/raw-notebook-4cc61e"
15+
colab_logo = "https://colab.research.google.com/assets/colab-badge.svg"
1516

1617
notebook_path = "tutorials/notebooks/$notebook_filename"
17-
binder_url = "https://mybinder.org/v2/gh/trixi-framework/Trixi.jl/tutorial_notebooks?filepath=$notebook_path"
18-
nbviewer_url = "https://nbviewer.jupyter.org/github/trixi-framework/Trixi.jl/blob/tutorial_notebooks/$notebook_path"
19-
raw_notebook_url = "https://raw.githubusercontent.com/trixi-framework/Trixi.jl/tutorial_notebooks/$notebook_path"
18+
binder_url = "https://mybinder.org/v2/gh/trixi-framework/TrixiDocumentation/tutorial_notebooks?filepath=$notebook_path"
19+
nbviewer_url = "https://nbviewer.jupyter.org/github/trixi-framework/TrixiDocumentation/blob/tutorial_notebooks/$notebook_path"
20+
raw_notebook_url = "https://raw.githubusercontent.com/trixi-framework/TrixiDocumentation/tutorial_notebooks/$notebook_path"
21+
colab_url = "https://colab.research.google.com/github/trixi-framework/TrixiDocumentation/blob/tutorial_notebooks/$notebook_path"
2022

2123
binder_badge = "# [![]($binder_logo)]($binder_url)"
2224
nbviewer_badge = "# [![]($nbviewer_logo)]($nbviewer_url)"
2325
raw_notebook_badge = "# [![]($raw_notebook_logo)]($raw_notebook_url)"
26+
colab_badge = "# [![]($colab_logo)]($colab_url)"
2427

2528
# Generate notebook file
2629
function preprocess_notebook(content)
@@ -33,7 +36,7 @@ function create_files(title, file, repo_src, pages_dir, notebooks_dir; folder =
3336

3437
# Generate markdown file
3538
function preprocess_docs(content)
36-
return string("# # [$title](@id $(splitext(file)[1]))\n $binder_badge\n $nbviewer_badge\n $raw_notebook_badge\n\n",
39+
return string("# # [$title](@id $(splitext(file)[1]))\n $binder_badge\n $nbviewer_badge\n $colab_badge\n $raw_notebook_badge\n\n",
3740
content)
3841
end
3942
Literate.markdown(joinpath(repo_src, folder, file), joinpath(pages_dir, folder);

0 commit comments

Comments
 (0)