/ docs / make.jl
make.jl
 1  using Documenter
 2  using Documenter.Remotes
 3  using GrothAlgebra
 4  using GrothCurves
 5  using GrothProofs
 6  
 7  DocMeta.setdocmeta!(GrothAlgebra, :DocTestSetup, :(using GrothAlgebra); recursive=true)
 8  DocMeta.setdocmeta!(GrothCurves, :DocTestSetup, :(using GrothCurves); recursive=true)
 9  DocMeta.setdocmeta!(GrothProofs, :DocTestSetup, :(using GrothProofs); recursive=true)
10  
11  const PAGES = [
12      "Home" => "index.md",
13      "Getting Started" => "getting-started.md",
14      "Packages" => [
15          "Groth Algebra" => "algebra.md",
16          "Groth Curves" => "curves.md",
17          "Groth Proofs" => "proofs.md",
18      ],
19      "References" => [
20          "Implementation Notes" => "implementation-notes.md",
21          "Implementation vs Arkworks" => "implementation-vs-arkworks.md",
22          "RareSkills Map" => "rareskills-map.md",
23          "Benchmarks" => "benchmarks.md",
24      ],
25  ]
26  
27  makedocs(
28      sitename = "Groth.jl",
29      format = Documenter.HTML(
30          prettyurls = true,
31          collapselevel = 1,
32          inventory_version = "dev",
33      ),
34      modules = [GrothAlgebra, GrothCurves, GrothProofs],
35      pages = PAGES,
36      clean = true,
37      checkdocs = :none,
38      repo = Remotes.GitHub("0xpantera", "Groth.jl"),
39      meta = Dict(
40          :description => "Groth.jl provides algebra, curve, and Groth16 proof tooling in Julia.",
41      ),
42  )
43  
44  deploydocs(
45      repo = "github.com/0xpantera/Groth.jl.git",
46      target = "build",
47      branch = "gh-pages",
48      devbranch = "master",
49      push_preview = true,
50  )