BeamletOptics.jl/docs/make.jl at 6e4db6eb4192c32abfdd81ef28c885ae0bc0aba1 · JuliaPhysics/BeamletOptics.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
using CairoMakie
using GLMakie
using BeamletOptics
using Documenter
using DocumenterCitations

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

bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))

makedocs(;
    modules=[BeamletOptics],
    authors="Hugo Uittenbosch <hugo.uittenbosch@dlr.de>, Oliver Kliebisch <oliver.kliebisch@dlr.de> and contributors",
    sitename="BeamletOptics.jl",
    format=Documenter.HTML(;
        prettyurls=get(ENV, "CI", "false") == "true",
        canonical="https://JuliaPhysics.github.io/BeamletOptics.jl",
        edit_link="master",
        assets=String[],
        size_threshold_ignore=["reference.md"],
        sidebar_sitename = false,
    ),
    pagesonly=true,
    pages=[
        "Home" => "index.md",
        "Getting started" => Any[
            "Tutorials" => Any[
                "Beam expander"             => joinpath("tutorials", "expander.md"),
                "Miniature microscope"      => joinpath("tutorials", "microscope.md"),
                "Michelson interferometer"  => joinpath("tutorials", "michelson.md"),
            ],
            "Examples" => Any[
                "Spherical lenses"          => joinpath("examples", "spherical_lenses.md"),
                "Aspherical lenses"         => joinpath("examples", "aspherical_lenses.md"),
                "Double Gauss lens"         => joinpath("examples", "double_gauss.md"),
                "Lens groups"               => joinpath("examples", "lens_groups.md"),
                "Double slit"               => joinpath("examples", "double_slit.md"),
            ],
        ],
        "Basics" => Any[
            "Introduction"                  => joinpath("basics", "intro.md"),
            "Rays"                          => joinpath("basics", "rays.md"),
            "Beams" => Any[
                "Basic beam"                => joinpath("basics", "beams", "beams.md"),
                "Stigmatic Gaussian"        => joinpath("basics", "beams", "stigmatic_beam.md"),
                "Astigmatic Gaussian"       => joinpath("basics", "beams", "astigmatic_beam.md"),
                "Beam groups"               => joinpath("basics", "beams", "beam_groups.md"),
            ],
            "Optical components" => Any[
                "Overview"                  => joinpath("basics", "components", "components.md"),
                "Mirrors"                   => joinpath("basics", "components", "mirrors.md"),
                "Lenses"                    => joinpath("basics", "components", "lenses.md"),
                "Beamsplitters"             => joinpath("basics", "components", "beamsplitters.md"),
                "Detectors"                 => joinpath("basics", "components", "detectors.md"),
                "Polarizing components"     => joinpath("basics", "components", "polarizers.md"),
            ],
            "Optical systems"               => joinpath("basics", "systems.md"),
            "Visualization"                 => joinpath("basics", "render.md"),
        ],
        "Developer Documentation" => Any[
            "Developer guide" => Any[
                "Contributing"              => joinpath("api", "contribute.md"),
                "Documentation development" => joinpath("api", "docdev.md"),
            ],
            "API design" => Any[
                "Introduction"              => joinpath("api", "api.md"),
                "Conventions"               => joinpath("api", "conventions.md"),
                "Core design"               => joinpath("api", "core.md"),
                "Geometry" => Any[
                    "Geometry representation"   => joinpath("api", "geometry.md"),
                    "Meshes"                    => joinpath("api", "meshes.md"),
                    "SDFs"                      => joinpath("api", "sdfs.md"),
                ],
            ],
        ],
        "Reference" => "reference.md"
    ],
    plugins=[bib],
)

deploydocs(;
    repo="github.com/JuliaPhysics/BeamletOptics.jl.git",
    devbranch="master",
    push_preview=false,
)