ExtendableFEM.jl/docs/make.jl at 4de2ce608f53ce1c93ce09586f084b06a6a6a0df · WIAS-PDELib/ExtendableFEM.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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
using Documenter
using ExampleJuggler
using CairoMakie
using ExtendableFEM

function make_all(; with_examples::Bool = true, modules = :all, run_examples::Bool = true, run_notebooks::Bool = false)

    module_examples = []

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

        example_dir = joinpath(@__DIR__, "..", "examples")

        if modules === :all
            modules = [
                "Example103_BurgersEquation.jl",
                "Example105_NonlinearPoissonEquation.jl",
                "Example106_NonlinearDiffusion.jl",
                "Example108_RobinBoundaryCondition.jl",
                "Example201_PoissonProblem.jl",
                "Example202_MixedPoissonProblem.jl",
                "Example203_PoissonProblemDG.jl",
                "Example204_LaplaceEVProblem.jl",
                "Example205_HeatEquation.jl",
                "Example206_CoupledSubGridProblems.jl",
                "Example207_AdvectionUpwindDG.jl",
                "Example210_LshapeAdaptivePoissonProblem.jl",
                "Example211_LshapeAdaptiveEQPoissonProblem.jl",
                "Example212_PeriodicElasticity2D.jl",
                "Example220_ReactionConvectionDiffusion.jl",
                "Example225_ObstacleProblem.jl",
                "Example226_Thermoforming.jl",
                "Example227_ObstacleProblemLVPP.jl",
                "Example230_NonlinearElasticity.jl",
                "Example235_StokesIteratedPenalty.jl",
                "Example240_SVRTEnrichment.jl",
                "Example245_NSEFlowAroundCylinder.jl",
                "Example250_NSELidDrivenCavity.jl",
                "Example252_NSEPlanarLatticeFlow.jl",
                "Example260_AxisymmetricNavierStokesProblem.jl",
                "Example264_StokesDarcy.jl",
                "Example265_FlowTransport.jl",
                "Example270_NaturalConvectionProblem.jl",
                "Example275_OptimalControlStokes.jl",
                "Example280_CompressibleStokes.jl",
                "Example282_IncompressibleMHD.jl",
                "Example284_LevelSetMethod.jl",
                "Example285_CahnHilliard.jl",
                "Example290_PoroElasticity.jl",
                "Example295_SlidingDroplet.jl",
                "Example301_PoissonProblem.jl",
                "Example310_DivFreeBasis.jl",
                "Example312_PeriodicElasticity3D.jl",
                "Example313_PeriodicPoisson.jl",
                "Example330_HyperElasticity.jl",
            ]
        end

        #notebooks = ["PlutoTemplate.jl"
        #             "Example with Graphics" => "ExamplePluto.jl"]

        cleanexamples()

        module_examples = @docmodules(example_dir, modules, Plotter = CairoMakie)
        #html_examples = @docplutonotebooks(example_dir, notebooks, iframe=false)
        #pluto_examples = @docplutonotebooks(example_dir, notebooks, iframe=true)
    end

    makedocs(
        modules = [ExtendableFEM],
        sitename = "ExtendableFEM.jl",
        authors = "Christian Merdon, Jan Philipp Thiele",
        format = Documenter.HTML(; repolink = "https://github.com/WIAS-PDELib/ExtendableFEM.jl", mathengine = MathJax3()),
        clean = false,
        checkdocs = :none,
        warnonly = false,
        doctest = true,
        pages = [
            "Home" => "index.md",
            "Index" => "package_index.md",
            "Problem Description" => [
                "problemdescription.md",
                "tensordescription.md",
                "nonlinearoperator.md",
                "bilinearoperator.md",
                "linearoperator.md",
                "restrictions.md",
                "interpolateboundarydata.md",
                "homogeneousdata.md",
                "fixdofs.md",
                "combinedofs.md",
                "callbackoperator.md",
                "allindex.md",
            ],
            "Solving" => Any[
                "pdesolvers.md",
                "pdesolvers_dt.md",
                "parallel_assembly.md",
            ],
            "Postprocessing" => Any[
                "postprocessing.md",
                "itemintegrators.md",
                "faceinterpolator.md",
            ],
            #"Tutorial Notebooks" => notebooks,
            "Examples" => module_examples,
        ],
    )

    return cleanexamples()

end

make_all(; with_examples = true, run_examples = true, run_notebooks = false)

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