From 398d6192a55d67a5d419e3975f310bbd34300a2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kadir=20=C3=87even?= Date: Sat, 25 May 2024 03:02:26 +0200 Subject: [PATCH] Fix the documenter --- docs/Project.toml | 1 - docs/make.jl | 26 ++++++++------------------ docs/package.json | 0 docs/src/.vitepress/config.mts | 0 docs/src/.vitepress/theme/index.ts | 0 docs/src/.vitepress/theme/style.css | 0 docs/src/index.md | 12 +++++------- docs/src/lib/public.md | 22 ---------------------- docs/src/manual/lattices.md | 5 ----- 9 files changed, 13 insertions(+), 53 deletions(-) mode change 100755 => 100644 docs/package.json mode change 100755 => 100644 docs/src/.vitepress/config.mts mode change 100755 => 100644 docs/src/.vitepress/theme/index.ts mode change 100755 => 100644 docs/src/.vitepress/theme/style.css delete mode 100644 docs/src/lib/public.md delete mode 100644 docs/src/manual/lattices.md diff --git a/docs/Project.toml b/docs/Project.toml index 9b094bf..9441786 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,4 +1,3 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365" -NeuralQuantumStates = "0d106a18-caf6-4288-a3af-53d8e0520c36" diff --git a/docs/make.jl b/docs/make.jl index bba377f..9aeccbc 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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, ) diff --git a/docs/package.json b/docs/package.json old mode 100755 new mode 100644 diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts old mode 100755 new mode 100644 diff --git a/docs/src/.vitepress/theme/index.ts b/docs/src/.vitepress/theme/index.ts old mode 100755 new mode 100644 diff --git a/docs/src/.vitepress/theme/style.css b/docs/src/.vitepress/theme/style.css old mode 100755 new mode 100644 diff --git a/docs/src/index.md b/docs/src/index.md index 74fff49..922d26e 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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] +``` diff --git a/docs/src/lib/public.md b/docs/src/lib/public.md deleted file mode 100644 index 2bd762a..0000000 --- a/docs/src/lib/public.md +++ /dev/null @@ -1,22 +0,0 @@ -```@meta -CurrentModule = NeuralQuantumStates -``` - -# Public API - -## Contents - -```@contents -Pages = ["public.md"] -Depth = 2 -``` - -## Index - -```@index -Pages = ["public.md"] -``` - -```@autodocs -Modules = [NeuralQuantumStates, NeuralQuantumStates.Lattices] -``` \ No newline at end of file diff --git a/docs/src/manual/lattices.md b/docs/src/manual/lattices.md deleted file mode 100644 index 1a3e7ba..0000000 --- a/docs/src/manual/lattices.md +++ /dev/null @@ -1,5 +0,0 @@ -```@meta -CurrentModule = NeuralQuantumStates -``` - -# Lattices \ No newline at end of file