Continue to twiddle.

JuliaManifolds · Nov 7, 2023 · 1abd0ec · 1abd0ec
1 parent 15a3fb2
commit 1abd0ec
Show file tree

Hide file tree

Showing 22 changed files with 72 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 docs/build
 docs/clones
 docs/Manifest.toml
+docs/out
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,4 @@
 [deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"
diff --git a/docs/make.jl b/docs/make.jl
@@ -11,10 +11,10 @@ docs/make.jl
 Render the `JuliaManifolds` GitHub Organisation Multidocumenter with optinal arguments
 
 Arguments
-* `--deploy`       - deploy docs
+* `--deploy`       - deploy docs to GitHub pages (e.g. on CI)
 * `--help`         - print this help and exit without rendering the documentation
+* `--serve`        - use `LiveServer.jl` to serve the current docs, also launches the browser
 * `--temp`         – clone the other repositories into a temp folder – otherwise use clones/
-* `--deploy`       - deploy docs to GitHub Pages
 """,
     )
     exit(0)
@@ -31,17 +31,38 @@ if Base.active_project() != joinpath(@__DIR__, "Project.toml")
 end
 
 clonedir = ("--temp" in ARGS) ? mktempdir() : joinpath(@__DIR__, "clones")
-outpath =  ("--temp" in ARGS) ? mktempdir() : joinpath(@__DIR__, "build")
+outpath =  ("--temp" in ARGS) ? mktempdir() : joinpath(@__DIR__, "out")
 
 @info """
 Cloning packages into: $(clonedir)
 Building aggregate site into: $(outpath)
 """
 
-using MultiDocumenter, LiveServer
+using MultiDocumenter, LiveServer, Documenter
 
-# ## Build Menu – for now an entry each
+# Build local docs
+makedocs(;
+    format=Documenter.HTML(;
+        prettyurls=false, assets=["assets/favicon.ico"]
+    ),
+    modules=Module[],
+    authors="Ronny Bergmann",
+    sitename="Julia Manifolds",
+    pages=[
+        "Home" => "index.md",
+    ]
+)
+
+# ## Build Multidocs – for now an entry each Repo
 docs = [
+    MultiDocumenter.MultiDocRef(
+        upstream = "build",
+        path = "juliamanifolds",
+        name = "Home",
+        giturl = "",
+        branch = "",
+        fix_canonical_url = false,
+    ),
     MultiDocumenter.MultiDocRef(
         upstream = joinpath(clonedir, "ManifoldsBase.jl"),
         path = "manifoldsbase",
@@ -86,7 +107,7 @@ docs = [
 MultiDocumenter.make(
     outpath,
     docs;
-    assets_dir = "docs/src/assets",
+    assets_dir = "src/assets",
     search_engine = MultiDocumenter.SearchConfig(
         index_versions = ["stable"],
         engine = MultiDocumenter.FlexSearch
@@ -98,7 +119,7 @@ MultiDocumenter.make(
 
 # ## Deploy
 if "--deploy" in ARGS
-    @warn "Deploying to GitHub" ARGS
+    @warn "Deploying to GitHub"
     gitroot = normpath(joinpath(@__DIR__, ".."))
     run(`git pull`)
     outbranch = "gh-pages"
@@ -136,3 +157,4 @@ else
     @info "Skipping deployment, '--deploy' not passed. Generated files in docs/$(outpath)."
 end
 # ## Serve ?
+("--serve" in ARGS) && serve(dir=joinpath(@__DIR__, outpath), launch_browser=true)
diff --git a/docs/src/assets/android-chrome-192x192.png b/docs/src/assets/android-chrome-192x192.png
diff --git a/docs/src/assets/android-chrome-512x512.png b/docs/src/assets/android-chrome-512x512.png
diff --git a/docs/src/assets/apple-touch-icon.png b/docs/src/assets/apple-touch-icon.png
diff --git a/docs/src/assets/citations.css b/docs/src/assets/citations.css
@@ -0,0 +1,19 @@
+/* Taken from https://juliadocs.org/DocumenterCitations.jl/v1.2/styling/ */
+
+.citation dl {
+  display: grid;
+  grid-template-columns: max-content auto; }
+.citation dt {
+  grid-column-start: 1; }
+.citation dd {
+  grid-column-start: 2;
+  margin-bottom: 0.75em; }
+.citation ul {
+ padding: 0 0 2.25em 0;
+ margin: 0;
+ list-style: none;}
+.citation ul li {
+ text-indent: -2.25em;
+ margin: 0.33em 0.5em 0.5em 2.25em;}
+.citation ol li {
+ padding-left:0.75em;}
diff --git a/docs/src/assets/favicon copy.ico b/docs/src/assets/favicon copy.ico
diff --git a/docs/src/assets/favicon-16x16 copy.png b/docs/src/assets/favicon-16x16 copy.png
diff --git a/docs/src/assets/favicon-16x16.png b/docs/src/assets/favicon-16x16.png
diff --git a/docs/src/assets/favicon-32x32 copy.png b/docs/src/assets/favicon-32x32 copy.png
diff --git a/docs/src/assets/favicon-32x32.png b/docs/src/assets/favicon-32x32.png
diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico
diff --git a/docs/src/assets/logo copy.png b/docs/src/assets/logo copy.png
diff --git a/docs/src/assets/logo-dark.png b/docs/src/assets/logo-dark.png
diff --git a/docs/src/assets/logo-dark_bg.png b/docs/src/assets/logo-dark_bg.png
diff --git a/docs/src/assets/logo-text-readme-dark.png b/docs/src/assets/logo-text-readme-dark.png
diff --git a/docs/src/assets/logo-text-readme.png b/docs/src/assets/logo-text-readme.png
diff --git a/docs/src/assets/logo_bg.png b/docs/src/assets/logo_bg.png
diff --git a/docs/src/assets/mstile-150x150.png b/docs/src/assets/mstile-150x150.png
diff --git a/docs/src/assets/site.webmanifest b/docs/src/assets/site.webmanifest
@@ -0,0 +1,19 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "/android-chrome-512x512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,3 @@
+# Julia Manifolds
+
+Hi!