add TextConfig/set_default_font cross references

cesaraustralia · Feb 11, 2022 · 3fcb8f8 · 3fcb8f8
1 parent c880323
commit 3fcb8f8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -268,6 +268,7 @@ Greyscale
 
 ```@docs
 TextConfig
+DynamicGrids.set_default_font
 ```
 
 

diff --git a/src/outputs/textconfig.jl b/src/outputs/textconfig.jl
@@ -8,7 +8,8 @@ Text configuration for printing timestep and grid name on the image.
 
 # Arguments / Keywords
 
-- `font`: A `FreeTypeAbstraction.FTFont`, or a `String` with the font name to look for. The `FTFont` may load more quickly.
+- `font`: A `FreeTypeAbstraction.FTFont`, or a `String` with the font name to look for.
+    The `FTFont` may load more quickly. See also [`set_default_font`](@ref).
 - `namepixels` and `timepixels`: the pixel size of the font.
 - `timepos` and `namepos`: tuples that set the label positions, in `Int` pixels.
 - `fcolor` and `bcolor`: the foreground and background colors, as `ARGB32`.
@@ -63,6 +64,8 @@ const _default_font_ref = Ref{FreeTypeAbstraction.FTFont}()
 """
 Set default font.
 
+See also [`TextConfig`](@ref)
+
 # Examples
 Using `findfont` to get the font by name:
 ```julia