Skip to content

Commit

Permalink
Fix the documenter
Browse files Browse the repository at this point in the history
  • Loading branch information
Kadir Çeven committed May 25, 2024
1 parent c0e4a84 commit 398d619
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 53 deletions.
1 change: 0 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
NeuralQuantumStates = "0d106a18-caf6-4288-a3af-53d8e0520c36"
26 changes: 8 additions & 18 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,34 +1,24 @@
using NeuralQuantumStates
using Documenter
using DocumenterVitepress
using Documenter, DocumenterVitepress

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

makedocs(;
modules=[NeuralQuantumStates],
repo=Remotes.GitHub("cevenkadir", "NeuralQuantumStates.jl"),
authors="Kadir Çeven",
sitename="NeuralQuantumStates.jl",
repo="https://github.com/cevenkadir/NeuralQuantumStates.jl",
sitename="Chairmarks.jl",
format=DocumenterVitepress.MarkdownVitepress(
repo="https://github.com/cevenkadir/NeuralQuantumStates.jl",
devurl="dev",
deploy_url="https://cevenkadir.github.io/NeuralQuantumStates.jl",
deploy_url="cevenkadir.github.io/NeuralQuantumStates.jl",
),
pages=[
"Home" => "index.md",
"Manual" => Any[
"Lattices"=>"manual/lattices.md",
],
"Reference" => Any[
"Public API"=>"lib/public.md",
],
]
],
warnonly=true,
)

deploydocs(;
repo="github.com/cevenkadir/NeuralQuantumStates.jl",
target="build", # this is where Vitepress stores its output
devbranch="main",
branch="gh-pages",
push_preview=true
push_preview=true,
)
Empty file modified docs/package.json
100755 → 100644
Empty file.
Empty file modified docs/src/.vitepress/config.mts
100755 → 100644
Empty file.
Empty file modified docs/src/.vitepress/theme/index.ts
100755 → 100644
Empty file.
Empty file modified docs/src/.vitepress/theme/style.css
100755 → 100644
Empty file.
12 changes: 5 additions & 7 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
```@meta
CurrentModule = NeuralQuantumStates
```

# NeuralQuantumStates

Documentation for [NeuralQuantumStates](https://github.com/cevenkadir/NeuralQuantumStates.jl).
# NeuralQuantumStates.jl

Documentation for `NeuralQuantumStates.jl`.

```@autodocs
Modules=[NeuralQuantumStates]
```
22 changes: 0 additions & 22 deletions docs/src/lib/public.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/src/manual/lattices.md

This file was deleted.

0 comments on commit 398d619

Please sign in to comment.