Peridynamics.jl/docs/make.jl at e16a2aee771959a637b4e75d6aaf6ae70d874c16 · kaipartmann/Peridynamics.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
const IS_CI = haskey(ENV, "GITHUB_ACTIONS")
const LIVE_MODE = "LIVE_MODE" in ARGS
if LIVE_MODE
    using Revise
    Revise.revise()
end

using Peridynamics
using Documenter
using Literate
using DocumenterCitations

bib = CitationBibliography(joinpath(@__DIR__, "src", "references.bib"), style=:alpha)

LIT_MD_OUT = joinpath(@__DIR__, "src", "generated")
# LIT_NB_OUT = joinpath(@__DIR__, "..", "notebooks") #TODO
rm(LIT_MD_OUT; recursive = true, force = true)
# rm(LIT_NB_OUT; recursive = true, force = true) #TODO

# LIT_MANUAL_IN = [
    # "howto_single_body_analysis.jl",
    # "howto_contact_analysis.jl",
    # "howto_pointclouds.jl",
    # "howto_precracks.jl",
    # "howto_matformulations.jl",
# ]
# LIT_MANUAL_IN .= joinpath.(@__DIR__, "src", "literate", LIT_MANUAL_IN)
# Literate.markdown.(LIT_MANUAL_IN, LIT_MD_OUT; credit=false)

LIT_TUTORIALS_IN = [
    "tutorial_tension_static.jl",
    "tutorial_tension_dynfrac.jl",
    "tutorial_tension_precrack.jl",
    "tutorial_wave_in_bar.jl",
    "tutorial_kalthoff-winkler_dynfrac.jl",
    "tutorial_logo.jl",
    "tutorial_cylinder.jl",
    "tutorial_wave_interface.jl",
    "tutorial_brazilian_test.jl",
]
LIT_TUTORIALS_IN .= joinpath.(@__DIR__, "src", "literate", LIT_TUTORIALS_IN)
Literate.markdown.(LIT_TUTORIALS_IN, LIT_MD_OUT; credit=false)
# Literate.notebook.(LIT_TUTORIALS_IN, LIT_NB_OUT; execute = IS_CI) #TODO

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

makedocs(;
    plugins = [bib],
    modules = [Peridynamics],
    authors = "Kai Partmann",
    repo = "https://github.com/kaipartmann/Peridynamics.jl/blob/{commit}{path}#{line}",
    sitename = "Peridynamics.jl",
    format = Documenter.HTML(;
        prettyurls = get(ENV, "CI", "false") == "true",
        canonical = "https://kaipartmann.github.io/Peridynamics.jl",
        edit_link = "main",
        assets = [joinpath("assets", "custom.css")],
        collapselevel = 1,
    ),
    draft = LIVE_MODE,
    pages = [
        "Home" => "index.md",
        "Explanations" => [
            "expl_general_pd.md",
            "expl_bondbased.md",
            "expl_osbased.md",
            "expl_nosbased.md",
            "expl_continuumbased.md",
            "expl_damage.md",
            "expl_references.md",
        ],
        "How-to guides" => [
            "howto_mpi.md",
            "howto_visualization.md",
            "howto_parameter-study.md",
        ],
        "Tutorials" => [
            joinpath("generated", "tutorial_tension_static.md"),
            joinpath("generated", "tutorial_tension_dynfrac.md"),
            joinpath("generated", "tutorial_tension_precrack.md"),
            joinpath("generated", "tutorial_wave_in_bar.md"),
            joinpath("generated", "tutorial_wave_interface.md"),
            joinpath("generated", "tutorial_kalthoff-winkler_dynfrac.md"),
            joinpath("generated", "tutorial_logo.md"),
            joinpath("generated", "tutorial_cylinder.md"),
            joinpath("generated", "tutorial_brazilian_test.md"),
        ],
        "Development" => [
            "dev_systems.md",
            "dev_materials.md",
            "dev_solvers.md",
            "dev_multithreading_mpi.md",
        ],
        "API Reference" => [
            "public_api_reference.md",
            "private_api_reference.md",
        ]
    ],

    # ONLY DURING EARLY DEVELOPMENT:
    # MISSING DOCSTRINGS DUE TO API CHANGES DO NOT RESULT IN ERRORS
    # THAT STOP THE DOCUMENTATION BUILD PROCESS!
    # warnonly = true,
)

if !LIVE_MODE
    deploydocs(;
        repo = "github.com/kaipartmann/Peridynamics.jl",
        devbranch = "main",
    )
end