view docs/make.jl @ 838:76e5682d0e52 feature/setup_documenter

Fix a bunch of docstring mistakes
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 09:19:07 +0100
parents 126e169bb0b7
children 23bce17a59cb
line wrap: on
line source

using Documenter
using Sbplib

using Sbplib.DiffOps
using Sbplib.Grids
using Sbplib.LazyTensors
using Sbplib.RegionIndices
using Sbplib.SbpOperators
using Sbplib.StaticDicts


sitename = "Sbplib.jl"
prettyurls = false
pages = [
    "index.md",
    "Submodules" => [
        "submodules/grids.md",
        "submodules/diff_ops.md",
        "submodules/lazy_tensors.md",
        "submodules/region_indices.md",
        "submodules/sbp_operators.md",
        "submodules/static_dicts.md",
    ],
    "doc_index.md",
]
# This ordering is not respected by @contents. See https://github.com/JuliaDocs/Documenter.jl/issues/936

format=Documenter.HTML(;prettyurls)
makedocs(;sitename, pages, format)
# TBD: Should `prettyurls` be true or false when this is deployed to a webserver?