From ecc7f826b631f639853598ee4aba5120a2c9b10b Mon Sep 17 00:00:00 2001
From: Elias Carvalho <73039601+eliascarv@users.noreply.github.com>
Date: Thu, 4 Jul 2024 15:53:27 -0300
Subject: [PATCH] Update to the latest version of Documenter.jl (#448)

* Update to the latest version of Documenter.jl

* Apply suggestions
---
 docs/Project.toml          |   3 -
 docs/make.jl               |  15 +---
 docs/src/assets/dark.scss  | 155 -------------------------------------
 docs/src/assets/light.scss | 121 -----------------------------
 4 files changed, 2 insertions(+), 292 deletions(-)
 delete mode 100644 docs/src/assets/dark.scss
 delete mode 100644 docs/src/assets/light.scss

diff --git a/docs/Project.toml b/docs/Project.toml
index a413f1024..c24b68de9 100644
--- a/docs/Project.toml
+++ b/docs/Project.toml
@@ -19,6 +19,3 @@ StratiGraphics = "135379e1-83be-5ae7-9e8e-29dade3dc6c7"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 TransformsBase = "28dd2a49-a57a-4bfb-84ca-1a49db9b96b8"
 TuringPatterns = "fde5428d-3bf0-5ade-b94a-d334303c4d77"
-
-[compat]
-Documenter = "0.27"
diff --git a/docs/make.jl b/docs/make.jl
index c84299d26..eb1792d70 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -12,21 +12,10 @@ using StratiGraphics
 # IO packages
 using GeoIO
 
-istravis = "TRAVIS" ∈ keys(ENV)
-
-Themes.compile(
-  joinpath(@__DIR__, "src/assets/light.scss"),
-  joinpath(@__DIR__, "src/assets/themes/documenter-light.css")
-)
-Themes.compile(joinpath(@__DIR__, "src/assets/dark.scss"), joinpath(@__DIR__, "src/assets/themes/documenter-dark.css"))
-
 makedocs(
   format=Documenter.HTML(
-    assets=[
-      "assets/favicon.ico",
-      asset("https://fonts.googleapis.com/css?family=Montserrat|Source+Code+Pro&display=swap", class=:css)
-    ],
-    prettyurls=istravis,
+    assets=["assets/favicon.ico"],
+    prettyurls=get(ENV, "CI", "false") == "true",
     mathengine=KaTeX(
       Dict(
         :macros => Dict(
diff --git a/docs/src/assets/dark.scss b/docs/src/assets/dark.scss
deleted file mode 100644
index 37236360c..000000000
--- a/docs/src/assets/dark.scss
+++ /dev/null
@@ -1,155 +0,0 @@
-@charset "UTF-8";
-// The customizable variables can be found here:
-// https://github.com/JuliaDocs/Documenter.jl/tree/master/assets/html/scss
-// under documenter/_variables or documenter/_overrides. But some stuff are Bulma defaults
-// as well, so you may need to look them up too: https://bulma.io/documentation/customize/variables/
-
-
-////////////////////////////////////////////////////////////////////////
-////////////////////////////////////////////////////////////////////////
-// These define the template:
-$maincolor: rgb(78, 134, 151);   // main color of the org theme
-$secondcolor: rgb(197, 96, 255); // secondary color that serves as accents
-                       // it is used as-is for links in light theme
-$mainwhite: #fff;      // color representing white
-$mainblack: #202020;   // color representing black
-$darkbg: #1e1e20;      // dark theme main page background
-
-// These commands set up the fonts for the main text and code blocks.
-// the fonts must be included into the assets of the `makdocs` command, with e.g.
-// format = Documenter.HTML(
-//     prettyurls = CI,
-//     assets = [
-//         "assets/logo.ico",
-//         asset("https://fonts.googleapis.com/css?family=Montserrat|Source+Code+Pro&display=swap", class=:css),
-//         ],
-//     ),
-$family-sans-serif: 'Montserrat', sans-serif;
-$family-monospace: 'Source Code Pro', monospace;
-////////////////////////////////////////////////////////////////////////
-////////////////////////////////////////////////////////////////////////
-
-// variables controlling the siderbar's shadow
-$shadow-color: #bbb !default;
-$shadow-size: 0.2rem !default;
-$shadow-blur: 0.4rem !default;
-
-// Two cool helper functions:
-$lightness-unit: 8% !default;
-// Uses adjust-color to create a darker version of $color
-@function darken-color($color, $factor) {
-  @return adjust-color($color, $lightness: -$factor*$lightness-unit);
-}
-// Uses adjust-color to create a lighter version of $color
-@function lighten-color($color, $factor) {
-  @return adjust-color($color, $lightness: $factor*$lightness-unit);
-}
-// This template file overrides some of the Documenter theme variables to customize the theme:
-$themename: "documenter-dark"; // CSS file must be called `$(themename).css`
-// Instruct documenter/*.scss files that this is a dark theme
-$documenter-is-dark-theme: true;
-
-$boldcolor: lighten-color($maincolor, 4.5);
-
-$body-background-color: $darkbg; // main page background
-
-// this is the color the links get, and also when they are hovered
-$link: lighten-color($secondcolor, 2);
-$link-hover: lighten-color($link, 3);
-
-// Main text color:
-$text: darken-color($mainwhite, 0.2);
-// Bold text color, also affects headers
-$text-strong: $boldcolor;
-
-// Code text color:
-$code: #fff;
-//$code-background: rgba(0.5,0,0, 0.05);
-$codebg: darken-color($maincolor, 3);
-$code-background: $codebg; // for inline code
-$pre-background: $codebg;  // for code blocks
-$documenter-docstring-header-background: lighten-color($body-background-color, 0.5);
-
-// Sidebar
-$documenter-sidebar-background: darken-color($maincolor, 1.2); //background color for sidebar
-$documenter-sidebar-color: $text; //font color for sidebar
-$documenter-sidebar-menu-hover-color: $documenter-sidebar-color;
-$documenter-sidebar-menu-hover-background: darken-color($documenter-sidebar-background, 1.2);
-
-$documenter-sidebar-menu-active-background: $darkbg;
-$documenter-sidebar-menu-active-color: $mainwhite;
-$documenter-sidebar-menu-active-hover-background: darken-color($documenter-sidebar-background, 1);
-$documenter-sidebar-menu-active-hover-color: $documenter-sidebar-menu-active-color;
-// these two change what happens with input boxes (the search box):
-$input-hover-border-color: $secondcolor;
-$input-focus-border-color: $mainwhite;
-
-$documenter-docstring-shadow: 3px 3px 4px invert($shadow-color);
-
-// Admonition stuff
-$admbg: lighten-color($body-background-color, 0.5);
-$admonition-background: (
-  'default': $admbg, 'info': $admbg, 'success': $admbg, 'warning': $admbg,
-  'danger': $admbg, 'compat': $admbg
-);
-$admonition-header-background: (
-  'default': #ba3f1f, 'warning': #a88b17, 'danger': #c7524c,
-  'success': #42ac68, 'info': #28c);
-
-// All secondary themes have to be nested in a theme--$(themename) class. When Documenter
-// switches themes, it applies this class to <html> and then disables the primary
-// stylesheet.
-@import "documenter/utilities";
-@import "documenter/variables";
-@import "bulma/utilities/all";
-@import "bulma/base/minireset.sass";
-@import "bulma/base/helpers.sass";
-
-html.theme--#{$themename} {
-  @import "bulma/base/generic.sass";
-
-  @import "documenter/overrides";
-
-  @import "bulma/elements/all";
-  @import "bulma/form/all";
-  @import "bulma/components/all";
-  @import "bulma/grid/all";
-  @import "bulma/layout/all";
-
-  // Additional overrides, if need be
-
-  @import "documenter/elements";
-  @import "documenter/components/all";
-  @import "documenter/patches";
-  @import "documenter/layout/all";
-
-  @import "documenter/theme_overrides";
-
-  // $shadow-color: #202224;
-
-  #documenter .docs-sidebar { // This makes sidebar have shadow at all displays
-    border-right: none;
-    box-shadow: 1.2*$shadow-size 0rem 1*$shadow-blur invert($shadow-color);
-
-    form.docs-search > input { // these controls are for the searchbar
-      color: $mainwhite;
-      background-color: darken-color($documenter-sidebar-background, 1);
-      border-color: darken-color($documenter-sidebar-background, 2);
-      margin-top: 1.0rem;
-      margin-bottom: 1.0rem; // adjust the margins between search and other elements
-      &::placeholder {
-        color: $mainwhite; // placeholder text color ("Search here...")
-      }
-    }
-  }
-  // FIXME: Hack to get a proper theme for highlight.js in the dark theme
-  @import "highlightjs/a11y-dark";
-  // Also, a11y-dark does not highlight string interpolation properly.
-  .hljs-subst {
-    color: #f8f8f2;
-  }
-}
-
-#documenter .admonition-header { // Color of notes
-  background-color: $maincolor;
-}
diff --git a/docs/src/assets/light.scss b/docs/src/assets/light.scss
deleted file mode 100644
index 1efed7db3..000000000
--- a/docs/src/assets/light.scss
+++ /dev/null
@@ -1,121 +0,0 @@
-@charset "UTF-8";
-// The customizable variables can be found here:
-// https://github.com/JuliaDocs/Documenter.jl/tree/master/assets/html/scss
-// under documenter/_variables or documenter/_overrides. But some stuff are Bulma defaults
-// as well, so you may need to look them up too: https://bulma.io/documentation/customize/variables/
-
-
-////////////////////////////////////////////////////////////////////////
-////////////////////////////////////////////////////////////////////////
-// These define the template:
-$maincolor: rgb(78, 134, 151);   // main color of the org theme
-$secondcolor: rgb(48, 23, 140); // secondary color that serves as accents
-                       // it is used as-is for links in light theme
-$mainwhite: #fff;      // color representing white
-$mainblack: #202020;   // color representing black
-$darkbg: #1e1e20;      // dark theme main page background
-
-// These commands set up the fonts for the main text and code blocks.
-// the fonts must be included into the assets of the `makdocs` command, with e.g.
-// format = Documenter.HTML(
-//     prettyurls = CI,
-//     assets = [
-//         "assets/logo.ico",
-//         asset("https://fonts.googleapis.com/css?family=Montserrat|Source+Code+Pro&display=swap", class=:css),
-//         ],
-//     ),
-$family-sans-serif: 'Montserrat', sans-serif;
-$family-monospace: 'Source Code Pro', monospace;
-////////////////////////////////////////////////////////////////////////
-////////////////////////////////////////////////////////////////////////
-
-// variables controlling the siderbar's shadow
-$shadow-color: #bbb !default;
-$shadow-size: 0.2rem !default;
-$shadow-blur: 0.4rem !default;
-
-// Two cool helper functions:
-$lightness-unit: 8% !default;
-// Uses adjust-color to create a darker version of $color
-@function darken-color($color, $factor) {
-  @return adjust-color($color, $lightness: -$factor*$lightness-unit);
-}
-// Uses adjust-color to create a lighter version of $color
-@function lighten-color($color, $factor) {
-  @return adjust-color($color, $lightness: $factor*$lightness-unit);
-}
-// This template file overrides some of the Documenter theme variables to customize the theme:
-$themename: "documenter-light"; // CSS file must be called `$(themename).css`
-
-$boldcolor: $maincolor; // darken-color($maincolor, 1);
-
-$body-background-color: $mainwhite; // main page background
-
-// Sidebar
-$documenter-sidebar-background: $maincolor; //background color for sidebar
-$documenter-sidebar-color: $mainwhite; //font color all sidebar
-$documenter-sidebar-menu-hover-color: $documenter-sidebar-color; // text color
-$documenter-sidebar-menu-hover-background: darken-color($documenter-sidebar-background, 1.5);
-
-$documenter-sidebar-menu-active-background: $mainwhite;
-$documenter-sidebar-menu-active-color: $mainblack;
-$documenter-sidebar-menu-active-hover-background: lighten-color($documenter-sidebar-background, 5.2);
-$documenter-sidebar-menu-active-hover-color: $documenter-sidebar-menu-active-color;
-
-// this is the color the links get, and also when they are hovered
-$link: $secondcolor;
-$link-hover: darken-color($link, 1);
-
-// Main text color:
-$text: $mainblack;
-// Bold text color, also affects headers
-$text-strong: $boldcolor;
-
-// Section headers (markdown ###) text color:
-// TODO
-
-// Code text color:
-$code: #000000;
-//$code-background: rgba(0.5,0,0, 0.05);
-$codebg: lighten-color($maincolor, 6.2);
-// $codebg: lighten-color($secondcolor, 8);
-$code-background: $codebg; // for inline code
-$pre-background: $codebg;  // for code blocks
-$documenter-docstring-header-background: darken-color($body-background-color, 0.4);
-
-// main text font size
-$body-font-size: 1.0em; // the default is 1.0
-// Sidebar text font size
-$documenter-sidebar-size: 1.0em; // the default is 1.0 as well
-
-// these two change what happens with input boxes (the search box):
-$input-hover-border-color: $secondcolor;
-$input-focus-border-color: $mainwhite;
-
-// Include the original theme which will now use the updated variables.
-// This should be the last thing in the SCSS file.
-@import "documenter-light";
-
-#documenter .docs-sidebar { // This makes sidebar have shadow at all displays
-  border-right: none;
-  box-shadow: 1.2*$shadow-size 0rem 1*$shadow-blur $shadow-color;
-
-  form.docs-search > input { // these controls are for the searchbar
-    color: $mainwhite;
-    background-color: darken-color($documenter-sidebar-background, 1);
-    border-color: darken-color($documenter-sidebar-background, 2);
-    margin-top: 1.0rem;
-    margin-bottom: 1.0rem; // adjust the margins between search and other elements
-    &::placeholder {
-      color: $mainwhite; // placeholder text color ("Search here...")
-    }
-  }
-}
-
-#documenter .content p { // Justify text in paragraphs
-  text-align: justify;
-}
-
-#documenter .admonition-header { // Color of notes
-  background-color: $maincolor;
-}