GridVisualize.jl/docs/make.jl at b10aa46853de45847b81fae623cf089e00a36b62 · WIAS-PDELib/GridVisualize.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
using Documenter, GridVisualize
import PlutoSliderServer # LoadError: Please import/use PlutoSliderServer.jl in order to use docplutonotebooks with `iframe=true`
using ExampleJuggler
import CairoMakie, PlutoVista # for docstrings and graphics generated by documentet
import Plots, PyPlot # for docstrings only
using ExtendableGrids
ExampleJuggler.verbose!(true)
using Test

GridVisualizeMakieExt = Base.get_extension(GridVisualize, :GridVisualizeMakieExt)
GridVisualizePlotsExt = Base.get_extension(GridVisualize, :GridVisualizePlotsExt)
GridVisualizePlutoVistaExt = Base.get_extension(GridVisualize, :GridVisualizePlutoVistaExt)
GridVisualizePyPlotExt = Base.get_extension(GridVisualize, :GridVisualizePyPlotExt)

# These are experimental, we exclude them from the documentation.
# GridVisualizeMeshCatExt = Base.get_extension(GridVisualize, :GridVisualizeMeshCatExt)
# GridVisualizeVTKViewExt = Base.get_extension(GridVisualize, :GridVisualizeVTKViewExt)


function mkdocs()
    cleanexamples()
    example_dir = joinpath(@__DIR__, "..", "examples")
    notebook_dir = joinpath(@__DIR__, "..", "examples")
    generated_examples = @docscripts(example_dir, ["Plotting Examples" => "plotting.jl"], Plotter = CairoMakie)
    notebook_examples = @docplutonotebooks(notebook_dir, ["plutovista.jl"], iframe = true, iframe_height = "2000px")
    makedocs(;
        sitename = "GridVisualize.jl",
        modules = [
            GridVisualize,
            GridVisualizeMakieExt,
            GridVisualizePlutoVistaExt,
            GridVisualizePyPlotExt,
            GridVisualizePlotsExt,
            # GridVisualizeVTKViewExt,
            # GridVisualizeMeshCatExt,
        ],
        doctest = false,
        clean = false,
        authors = "J. Fuhrmann and contributors",
        repo = "https://github.com/WIAS-PDELib/GridVisualize.jl",
        pages = [
            "Home" => "index.md",
            "Public API" => "api.md",
            "Examples" => generated_examples,
            "Pluto notebooks" => notebook_examples,
            "Private API" => "privapi.md",
            "Contributing" => "contributing.md",
        ]
    )
    return nothing

end

mkdocs()

deploydocs(; repo = "github.com/WIAS-PDELib/GridVisualize.jl.git", devbranch = "main")