Added documentation

MakieOrg · Jul 24, 2024 · a928ec4 · a928ec4
1 parent 794da31
commit a928ec4
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 1 deletion.
diff --git a/docs/make.jl b/docs/make.jl
@@ -56,6 +56,7 @@ makedocs(;
         "Home" => "index.md",
         "GGThemr" => "themes/ggthemr.md",
         "BBC" => "themes/bbc.md",
+        "Gruvbox" => "themes/gruvbox.md",
         "API" => "api.md"
     ],
     warnonly = true,
@@ -68,4 +69,4 @@ deploydocs(;
 )
 
 # clean up
-# rm(joinpath(@__DIR__, "src", "themes", "ggthemr.jl"))
+# rm(joinpath(@__DIR__, "src", "themes", "ggthemr.jl"))
diff --git a/docs/src/themes/gruvbox.md b/docs/src/themes/gruvbox.md
@@ -0,0 +1,45 @@
+```@setup gruvbox
+using MakieThemes, CairoMakie
+```
+
+# Gruvbox
+
+The Gruvbox theme[^1] is accessible through `color_gruvbox_light()`
+and `color_gruvbox_dark()`.
+
+[^1]:
+    <https://github.com/morhetz/gruvbox>;
+    <https://github.com/gruvbox-community/gruvbox>
+
+```julia
+MakieThemes.demofigure(color_gruvbox_light())
+```
+```@raw html
+<img src="../../assets/img/demofigure/gruvbox-light.png" alt="Gruvbox light color theme" width="900"/>
+```
+
+```julia
+MakieThemes.demofigure(color_gruvbox_dark())
+```
+```@raw html
+<img src="../../assets/img/demofigure/gruvbox-dark.png" alt="Gruvbox dark color theme" width="900"/>
+```
+
+```julia
+MakieThemes.demoscatter(color_gruvbox_light())
+```
+```@raw html
+<img src="../../assets/img/demoscatter/gruvbox-light.png" alt="Gruvbox light color theme" width="900"/>
+```
+
+```julia
+MakieThemes.demoscatter(color_gruvbox_dark())
+```
+```@raw html
+<img src="../../assets/img/demoscatter/gruvbox-dark.png" alt="Gruvbox dark color theme" width="900"/>
+```
+
+```@docs
+color_gruvbox_light
+color_gruvbox_dark
+```
diff --git a/img/demofigure/gruvbox-dark.png b/img/demofigure/gruvbox-dark.png
diff --git a/img/demofigure/gruvbox-light.png b/img/demofigure/gruvbox-light.png
diff --git a/img/demoscatter/gruvbox-dark.png b/img/demoscatter/gruvbox-dark.png
diff --git a/img/demoscatter/gruvbox-light.png b/img/demoscatter/gruvbox-light.png
diff --git a/src/Gruvbox.jl b/src/Gruvbox.jl
@@ -168,9 +168,23 @@ function color_gruvbox(palette; use_alt_bg=true)
     )
 end
 
+"""
+    color_gruvbox_light(; use_alt_bg=true)
+
+Set up the light version of the Gruvbox color theme. Optionally, use a
+slightly different background color for axes backgrounds, etc
+(default).
+"""
 color_gruvbox_light(;kwargs...) =
     color_gruvbox(gruvbox_light_palette; kwargs...)
 
+"""
+    color_gruvbox_dark(; use_alt_bg=true)
+
+Set up the dark version of the Gruvbox color theme. Optionally, use a
+slightly different background color for axes backgrounds, etc
+(default).
+"""
 color_gruvbox_dark(;kwargs...) =
     color_gruvbox(gruvbox_dark_palette; kwargs...)