Skip to content

Commit 8abdafd

Browse files
committed
Tweak language in docs re: tidelift_url
1 parent 9c78c1b commit 8abdafd

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/customization.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,13 @@ Variables and feature toggles
107107
string - used to display a `Travis-CI <https://travis-ci.org>`_ build status
108108
button in the sidebar. If ``true``, uses your ``github_(user|repo)``
109109
settings.
110-
* ``tidelift_url``: Set your `Tidelift <https://tidelift.com/>`_ project
111-
URL if you want a "Professional support" section in your sidebar.
110+
* ``tidelift_url``: Set this to your `Tidelift <https://tidelift.com/>`_
111+
project URL if you want a "Professional support" section in your sidebar.
112+
113+
- Requires ``donation.html`` to be enabled in your ``html_sidebars`` option.
114+
- If copying the URL straight from Tidelift's site, you'll probably want to
115+
change ``&utm_campaign=readme`` to ``&utm_campaign=docs``.
116+
112117
* ``codecov_button``: ``true``, ``false`` or a Github-style ``"account/repo"``
113118
string - used to display a `Codecov <https://codecov.io>`_ build status
114119
button in the sidebar. If ``true``, uses your ``github_(user|repo)``

0 commit comments

Comments
 (0)