Merge pull request #906 from CliMA/ar/docs_colored_strings

colored strings in docs
CliMA · Nov 1, 2024 · ac3af5f · ac3af5f
2 parents f3e8648 + 4f333a4
commit ac3af5f
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -26,4 +26,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-        run: julia --project=docs/ docs/make.jl
+        run: julia --color=yes --project=docs/ docs/make.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -74,6 +74,7 @@ format = Documenter.HTML(
     prettyurls = !isempty(get(ENV, "CI", "")),
     collapselevel = 1,
     mathengine = mathengine,
+    ansicolor = true,
 )
 
 makedocs(

diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md
@@ -55,6 +55,8 @@ using About
 about(ClimaLand.Soil.Biogeochemistry)
 ```
 
+Where modules are shown in red, functions are shown in blue, and types are shown in yellow.
+
 To see the documentation about a particular module, function or type, you can use ? to go in help mode
 in the REPL, or `@doc` as in [Parameterization above](#Parameterization).