Skip to content

Commit

Permalink
Add documentation files
Browse files Browse the repository at this point in the history
  • Loading branch information
ykharkov committed Mar 4, 2024
1 parent 553db56 commit 7f10be6
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[deps]
BraketAHS = "aad1d28c-1a3f-47da-806d-2ed76430c1d6"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
23 changes: 23 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -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",
)
14 changes: 14 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@meta
CurrentModule = BraketAHS
```

# BraketAHS

Documentation for [BraketAHS](https://github.com/ykharkov/BraketAHS.jl).

```@index
```

```@autodocs
Modules = [BraketAHS]
```

0 comments on commit 7f10be6

Please sign in to comment.