docs

Author: oameye

docs/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
+QuestBase = "7e80f742-43d6-403d-a9ea-981410111d43"

docs/make.jl

@@ -0,0 +1,30 @@
+CI = get(ENV, "CI", nothing) == "true" || get(ENV, "GITHUB_TOKEN", nothing) !== nothing
+
+using QuestBase
+using Documenter
+
+include("pages.jl")
+
+makedocs(;
+    sitename="QuestBase.jl",
+    authors="Quest group",
+    modules=QuestBase,
+    format=Documenter.HTML(
+    canonical = "https://quantumengineeredsystems.github.io/QuestBase.jl/stable/"),
+    pages = pages,
+    clean = true,
+    linkcheck = true,
+    warnonly = :missing_docs,
+    draft=!CI,
+    doctest=false,  # We test it in the CI, no need to run it here
+)
+
+if CI
+    deploydocs(;
+        repo="github.com/QuantumEngineeredSystems/QuestBase.jl";
+        # devbranch="master",
+        # target="build",
+        # branch="gh-pages",
+        push_preview=true,
+    )
+end

docs/pages.jl

@@ -0,0 +1,4 @@
+pages = [
+    "Home" => "index.md",
+    "API" => "API.md"
+]

docs/src/API.md

@@ -0,0 +1,19 @@
+# API
+
+## Symbolic Utilies
+
+```@docs
+
+```
+
+## Classical harmonic systems
+
+```@docs
+
+```
+
+## Classical harmonic systems
+
+```@docs
+
+```

docs/src/index.md

@@ -0,0 +1,9 @@
+# The Common Interface for the QUEST ecosystem
+
+The QUEST common interface ties together the utilies of the ecosystem into a single unified interface.
+It is designed ensure compatiabilty between the different available packages.
+
+This documentation is made to pool together the docs of the various Quest libraries
+to paint the overarching picture and document the shared/common functionality.
+
+<!-- ## Packages of Quest Ecosystem -->