Skip to content

Commit

Permalink
Adding draft
Browse files Browse the repository at this point in the history
  • Loading branch information
wallytutor committed May 1, 2024
1 parent 64e481b commit af95edc
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 4 deletions.
43 changes: 40 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import PlutoStaticHTML
# THE DOCUMENTED *PACKAGES*
##############################################################################

# XXX: I could not find a way that `dev` installs the dependencies of the
# XXX: I could not find a way that `dev` installs the dependencies of the
# parent project, as it *LOGICALLY* should be the case. To be able to document
# the following I was forced to add the same dependencies in the project file
# docs/Project.toml, so when adding new dependencies to the parent, do not
Expand All @@ -34,6 +34,39 @@ using DryUtilities
using OpenFOAM
using RadCalNet

##############################################################################
# DRAFT
##############################################################################

# "Generate documentation for notebooks."
# function docplutonotebooks(example_dir, notebooks;
# distributed = true, force = true)
# notebookmd = [splitext(notebook)[1] * ".md" for notebook in notebooks]
# output_format = PlutoStaticHTML.documenter_output

# oopts = PlutoStaticHTML.OutputOptions(; append_build_context = false)
# bopts = PlutoStaticHTML.BuildOptions(example_dir; output_format)

# session = PlutoStaticHTML.Pluto.ServerSession()
# session.options.server.disable_writing_notebook_files = true
# session.options.server.show_file_system = false
# session.options.server.launch_browser = false
# session.options.server.dismiss_update_notification = true
# session.options.evaluation.workspace_use_distributed = distributed

# PlutoStaticHTML.build_notebooks(bopts, notebooks, oopts; session)

# for nb in notebookmd
# src = joinpath(example_dir, nb)
# dst = joinpath(@__DIR__, "src/Notebooks", nb);
# mv(src, dst; force)
# end
# end

# docplutonotebooks(joinpath(@__DIR__, "..", "script"), [
# "dsc-tga-kaolinite.jl",
# ])

##############################################################################
# THE CONFIGURATION
##############################################################################
Expand Down Expand Up @@ -81,13 +114,17 @@ pages = [
"DryTransport" => "DryTransport/index.md",
"Helpers" => "helpers.md"
],

"Cantera" => "Cantera/index.md",
"OpenFOAM" => "OpenFOAM/index.md",
"RadCalNet" => "RadCalNet/index.md",
"Table of Contents" => "toc.md",
"References" => "References/index.md",

# "Notebooks" => [
# "Simulating DSC/TGA" => "Notebooks/dsc-tga-kaolinite.md"
# ],

"Teaching" => [
"Machine Learning" => "Teaching/Machine Learning/index.md",
"Transport Phenomena" => "Teaching/Transport Phenomena/index.md",
Expand All @@ -111,7 +148,7 @@ function formatter(text)
oldgroup = r"\$\$(?<named>[^$]*)\$\$"
return replace(text, oldgroup => newgroup)
end

function formatcitations(text)
# TODO get this working:
# path = replace("$(@__DIR__)/tmp/References", "\\" => "/", ":" => "")
Expand Down
2 changes: 1 addition & 1 deletion docs/src/DryCombustion/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ CurrentModule = DryCombustion
DocTestSetup = quote
using DryCombustion
end
_EditURL = "/WallyToolbox.jl/docs/src/DryCombustion/index.md"
EditURL = "https://github.com/wallytutor/WallyToolbox.jl/blob/main/docs/src/DryCombustion/index.md"
```

## Heavy fuel-oils
Expand Down
2 changes: 2 additions & 0 deletions script/dsc-tga-kaolinite.jl
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ begin
using WallyToolbox
using DryConstants
import DryMaterials as DM

CairoMakie.activate!(; type = "svg", visible = false)
end

# ╔═╡ 062e6786-9518-4420-9ae2-6182508a5fa8
Expand Down

0 comments on commit af95edc

Please sign in to comment.