diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..7b7f6b6 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +BraketAHS = "aad1d28c-1a3f-47da-806d-2ed76430c1d6" +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..7425ea6 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,23 @@ +using BraketAHS +using Documenter + +DocMeta.setdocmeta!(BraketAHS, :DocTestSetup, :(using BraketAHS); recursive=true) + +makedocs(; + modules=[BraketAHS], + authors="Yaroslav Kharkov, Katharine Hyatt", + sitename="BraketAHS.jl", + format=Documenter.HTML(; + canonical="https://ykharkov.github.io/BraketAHS.jl", + edit_link="main", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/ykharkov/BraketAHS.jl", + devbranch="main", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..9aa93c3 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = BraketAHS +``` + +# BraketAHS + +Documentation for [BraketAHS](https://github.com/ykharkov/BraketAHS.jl). + +```@index +``` + +```@autodocs +Modules = [BraketAHS] +```