ExtendableFEMBase.jl/docs/make.jl at a53680ff4779e2ed5751c8a922ea9856c5a85e0b · WIAS-PDELib/ExtendableFEMBase.jl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
using Documenter
using ExtendableFEMBase
using ExampleJuggler
using PlutoStaticHTML
using CairoMakie


function make_all(; with_examples::Bool = true)

    module_examples = []
    pluto_examples = []

    if with_examples

        DocMeta.setdocmeta!(ExampleJuggler, :DocTestSetup, :(using ExampleJuggler); recursive = true)

        example_dir = joinpath(@__DIR__, "..", "examples")
        pluto_example_dir = joinpath(@__DIR__, "..", "pluto-examples")

        modules = [
            "Example200_LowLevelPoisson.jl",
            "Example205_LowLevelSpaceTimePoisson.jl",
            "Example210_LowLevelNavierStokes.jl",
            "Example280_BasisPlotter.jl",
            "Example281_DiscontinuousPlot.jl",
            "Example290_InterpolationBetweenMeshes.jl",
        ]

        notebooks = [
            "Low level Poisson" => "LowLevelPoisson.jl"
            "Low level Navier-Stokes" => "LowLevelNavierStokes.jl"
        ]

        cleanexamples()

        module_examples = @docmodules(example_dir, modules, Plotter = CairoMakie)
        pluto_examples = @docplutonotebooks(pluto_example_dir, notebooks, iframe = false)
        pushfirst!(module_examples, "Introduction" => "examples_intro.md")

    end

    makedocs(
        modules = [ExtendableFEMBase],
        sitename = "ExtendableFEMBase.jl",
        authors = "Christian Merdon",
        format = Documenter.HTML(repolink = "https://github.com/WIAS-PDELib/ExtendableFEMBase.jl", size_threshold = 250000, mathengine = MathJax3()),
        clean = false,
        checkdocs = :none, # :all or :exports currently causes UndefVarError
        warnonly = false,
        doctest = true,
        pages = [
            "Home" => "index.md",
            "Index" => "package_index.md",
            "List of Finite Elements" => "fems.md",
            "Base Structures" => Any[
                "fespace.md",
                "fevector.md",
                "fematrix.md",
                "functionoperators.md",
                "feevaluator.md",
                "interpolations.md",
                "quadrature.md",
            ],
            "Advanced Stuff" => Any[
                "pointevaluators.md",
                "segmentintegrators.md",
                "plots.md",
            ],
            "Tutorial Notebooks" => pluto_examples,
            "Examples" => module_examples,
        ]
    )

    return cleanexamples()

end

make_all(; with_examples = true)

deploydocs(
    repo = "github.com/WIAS-PDELib/ExtendableFEMBase.jl",
)