examples: mention that source links are optional

Some folks might be put off by the source links, others might struggle figuring out how they're enabled. Pointing at the option helps both.
jnikula · Nov 19, 2023 · 0a4a2c1 · 0a4a2c1
1 parent 9c20afb
commit 0a4a2c1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/doc/examples.rst b/doc/examples.rst
@@ -8,6 +8,9 @@ Examples
 
 This page showcases Hawkmoth in action.
 
+The ``[source]`` links are optional, and can be enabled via the
+:py:data:`hawkmoth_source_uri` option.
+
 .. contents::
    :local:
    :depth: 1

diff --git a/test/update-examples.py b/test/update-examples.py
@@ -33,6 +33,9 @@ def print_header():
 
 This page showcases Hawkmoth in action.
 
+The ``[source]`` links are optional, and can be enabled via the
+:py:data:`hawkmoth_source_uri` option.
+
 .. contents::
    :local:
    :depth: 1