mirror of
https://github.com/fverdugo/XM_40017.git
synced 2025-11-09 00:14:23 +01:00
138 lines
4.7 KiB
Julia
138 lines
4.7 KiB
Julia
using XM_40017
|
|
using Documenter
|
|
using Glob
|
|
|
|
const md_nb_template = """
|
|
```@meta
|
|
EditURL = "https://github.com/fverdugo/XM_40017/blob/main/docs/src/notebooks/SCRIPT_NAME.ipynb"
|
|
```
|
|
|
|
```@raw html
|
|
<div class="admonition is-success">
|
|
<header class="admonition-header">Tip</header>
|
|
<div class="admonition-body">
|
|
<ul>
|
|
<li>
|
|
Download this notebook and run it locally on your machine [recommended]. Click <a href="notebooks/SCRIPT_NAME.ipynb" download>here</a>.
|
|
</li>
|
|
<li>
|
|
You can also run this notebook in the cloud using Binder. Click <a href="https://mybinder.org/v2/gh/fverdugo/XM_40017/gh-pages?filepath=dev/notebooks/SCRIPT_NAME.ipynb">here</a>
|
|
.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
```
|
|
|
|
```@raw html
|
|
<iframe id="notebook" src="../notebook-output/SCRIPT_NAME.html" style="width:100%"></iframe>
|
|
<script>
|
|
document.addEventListener('DOMContentLoaded', function(){
|
|
var myIframe = document.getElementById("notebook");
|
|
iFrameResize({log:true}, myIframe);
|
|
});
|
|
</script>
|
|
```
|
|
"""
|
|
|
|
function convert_embedded_img_to_base64(notebook_path)
|
|
doc = open(io->read(io, String), notebook_path)
|
|
# Regex matching: extract filename and base64 code
|
|
regex = r"attachments\\\":\s*\{\s*\\\"(?<filename>.*).png\\\":\s*\{\s*\\\"image/png\\\":\s*\\\"(?<base64code>.*)\\\""
|
|
res = eachmatch(regex, doc)
|
|
matches = collect(res)
|
|
# Replace img src with base64 code
|
|
for m in matches
|
|
filename = m[:filename]
|
|
base64 = m[:base64code]
|
|
doc = replace(doc, "attachment:$filename.png" => "data:image/png;base64,$base64")
|
|
end
|
|
|
|
write(notebook_path, doc);
|
|
end
|
|
|
|
# Write markdown file that includes notebook html
|
|
function create_md_nb_file( notebook_path )
|
|
global md_nb_template;
|
|
script_file = splitpath(notebook_path)[end]
|
|
script_name = splitext(script_file)[1]
|
|
content = replace(md_nb_template, "SCRIPT_NAME" => script_name)
|
|
md_path = joinpath(@__DIR__, "src", script_name * ".md" )
|
|
open(md_path, "w") do md_file
|
|
write(md_file, content)
|
|
end
|
|
return md_path
|
|
end
|
|
|
|
# Convert to html using nbconvert
|
|
function convert_notebook_to_html(notebook_path; output_name = "index", output_dir = "./docs/src/notebook-output", theme = "light")
|
|
command_jup = "jupyter"
|
|
command_nbc = "nbconvert"
|
|
output_format = "--to=html"
|
|
theme = "--theme=$theme"
|
|
output = "--output=$output_name"
|
|
output_dir = "--output-dir=$output_dir"
|
|
infile = notebook_path
|
|
run(`$command_jup $command_nbc $output_format $output $output_dir $theme $infile`)
|
|
end
|
|
|
|
# Resize iframes using IframeResizer
|
|
function modify_notebook_html( html_name )
|
|
content = open( html_name, "r" ) do html_file
|
|
read( html_file, String )
|
|
end
|
|
content = replace(content,
|
|
r"(<script\b[^>]*>[\s\S]*?<\/script>\K)" =>
|
|
s"\1\n\t<script src='../assets/iframeResizer.contentWindow.min.js'></script>\n";
|
|
count = 1
|
|
)
|
|
content = replace_colors(content)
|
|
open( html_name, "w" ) do html_file
|
|
write( html_file, content )
|
|
end
|
|
return nothing
|
|
end
|
|
|
|
# Replace colors to match Documenter.jl
|
|
function replace_colors(content)
|
|
#content = replace( content, "--jp-layout-color0: #111111;" => "--jp-layout-color0: #1f2424;")
|
|
#content = replace(content, "--md-grey-900: #212121;" => "--md-grey-900: #282f2f;")
|
|
return content
|
|
end
|
|
|
|
# Loop over notebooks and generate html and markdown
|
|
notebook_files = glob("*.ipynb", "docs/src/notebooks/")
|
|
for filepath in notebook_files
|
|
convert_embedded_img_to_base64(filepath)
|
|
create_md_nb_file(filepath)
|
|
filename_with_ext = splitpath(filepath)[end]
|
|
filename = splitext(filename_with_ext)[1]
|
|
convert_notebook_to_html(filepath, output_name = filename)
|
|
modify_notebook_html("docs/src/notebook-output/$(filename).html")
|
|
end
|
|
|
|
makedocs(;
|
|
modules=[XM_40017],
|
|
authors="Francesc Verdugo <f.verdugo.rojano@vu.nl>",
|
|
repo="https://github.com/fverdugo/XM_40017/blob/{commit}{path}#{line}",
|
|
sitename="XM_40017",
|
|
format=Documenter.HTML(;
|
|
assets = ["assets/favicon.ico", "assets/iframeResizer.min.js", "assets/custom.css"],
|
|
prettyurls=get(ENV, "CI", "false") == "true",
|
|
canonical="https://fverdugo.github.io/XM_40017",
|
|
edit_link="main",),
|
|
pages=["Home" => "index.md","Getting started"=>"getting_started_with_julia.md", "Notebooks"=>[
|
|
"Julia Basics" => "julia_basics.md",
|
|
"Tasks and channels" => "julia_async.md",
|
|
"Remote calls and remote channels" => "julia_distributed.md",
|
|
"Matrix Multiplication"=>"matrix_matrix.md",
|
|
"Jacobi/SOR" => "julia_jacobi.md",
|
|
"Solutions" => "sol_matrix_matrix.md"
|
|
]],
|
|
)
|
|
|
|
deploydocs(;
|
|
repo="github.com/fverdugo/XM_40017",
|
|
devbranch="main",
|
|
)
|