Skip to content

Commit

Permalink
examples: mention that source links are optional
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jnikula committed Nov 19, 2023
1 parent 32ab183 commit 645508d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions test/update-examples.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 645508d

Please sign in to comment.