changeset 841:23bce17a59cb feature/setup_documenter

Implement flag to controll pretty urls
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 09:59:41 +0100
parents 221ce98d2612
children ef78f730cbb4
files Makefile docs/make.jl
diffstat 2 files changed, 9 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
diff -r 221ce98d2612 -r 23bce17a59cb Makefile
--- a/Makefile	Fri Jan 14 09:49:47 2022 +0100
+++ b/Makefile	Fri Jan 14 09:59:41 2022 +0100
@@ -5,10 +5,10 @@
 	@echo '    localdocs   - Generate docs for local viewing.'
 
 docs:
-	julia --project=docs --startup-file=no docs/make.jl
+	julia --project=docs --startup-file=no docs/make.jl --prettyurls
 
 localdocs:
-	julia --project=docs --startup-file=no docs/make.jl ## TODO
+	julia --project=docs --startup-file=no docs/make.jl
 
 clean:
 	rm -r docs/build
diff -r 221ce98d2612 -r 23bce17a59cb docs/make.jl
--- a/docs/make.jl	Fri Jan 14 09:49:47 2022 +0100
+++ b/docs/make.jl	Fri Jan 14 09:59:41 2022 +0100
@@ -8,9 +8,14 @@
 using Sbplib.SbpOperators
 using Sbplib.StaticDicts
 
+sitename = "Sbplib.jl"
 
-sitename = "Sbplib.jl"
-prettyurls = false
+if "--prettyurls" ∈ ARGS
+    prettyurls = true
+else
+    prettyurls = false
+end
+
 pages = [
     "index.md",
     "Submodules" => [
@@ -27,4 +32,3 @@
 
 format=Documenter.HTML(;prettyurls)
 makedocs(;sitename, pages, format)
-# TBD: Should `prettyurls` be true or false when this is deployed to a webserver?