docs: trigger build for docs

LuxDL · Nov 16, 2024 · 34b8015 · 34b8015
1 parent 888ea1e
commit 34b8015
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 10 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -81,7 +81,8 @@ deploy_config = Documenter.auto_detect_deploy_system()
 deploy_decision = Documenter.deploy_folder(deploy_config; repo="github.com/LuxDL/Lux.jl",
     devbranch="main", devurl="dev", push_preview=true)
 
-makedocs(; sitename="Lux.jl Docs",
+makedocs(;
+    sitename="Lux.jl Docs",
     authors="Avik Pal et al.",
     clean=true,
     doctest=false,  # We test it in the CI, no need to run it here
@@ -97,7 +98,10 @@ makedocs(; sitename="Lux.jl Docs",
         repo="github.com/LuxDL/Lux.jl", devbranch="main", devurl="dev",
         deploy_url="https://lux.csail.mit.edu", deploy_decision),
     draft=false,
-    pages)
+    pages
+)
 
-deploydocs(; repo="github.com/LuxDL/Lux.jl.git",
-    push_preview=true, target="build", devbranch="main")
+deploydocs(;
+    repo="github.com/LuxDL/Lux.jl.git",
+    push_preview=true, target="build", devbranch="main"
+)
diff --git a/docs/run_single_tutorial.jl b/docs/run_single_tutorial.jl
@@ -67,4 +67,5 @@ end
 
 Literate.markdown(
     path, output_directory; execute=true, name, flavor=Literate.DocumenterFlavor(),
-    preprocess=Base.Fix1(preprocess, path), postprocess=Base.Fix1(postprocess, path))
+    preprocess=Base.Fix1(preprocess, path), postprocess=Base.Fix1(postprocess, path)
+)
diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts
@@ -5,16 +5,16 @@ import footnote from "markdown-it-footnote";
 import { transformerMetaWordHighlight } from "@shikijs/transformers";
 
 const baseTemp = {
-  base: "REPLACE_ME_DOCUMENTER_VITEPRESS", // TODO: replace this in makedocs!
+  base: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // TODO: replace this in makedocs!
 };
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  base: "REPLACE_ME_DOCUMENTER_VITEPRESS",
-  title: "REPLACE_ME_DOCUMENTER_VITEPRESS",
+  base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+  title: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
   description: "Documentation for LuxDL Repositories",
   cleanUrls: true,
-  outDir: "REPLACE_ME_DOCUMENTER_VITEPRESS", // This is required for MarkdownVitepress to work correctly...
+  outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
 
   markdown: {
     math: true,
@@ -424,7 +424,7 @@ export default defineConfig({
       text: "Edit this page on GitHub",
     },
     socialLinks: [
-      { icon: "github", link: "REPLACE_ME_DOCUMENTER_VITEPRESS" },
+      { icon: "github", link: 'REPLACE_ME_DOCUMENTER_VITEPRESS' },
       { icon: "twitter", link: "https://twitter.com/avikpal1410" },
       { icon: "slack", link: "https://julialang.org/slack/" },
     ],