Skip to content

Commit f09f526

Browse files
committed
Remove/fix donate/donation.html references
- It's donate.html, not donation.html - But also there's no point referencing it in the customization docs, it's been in our default list for install docs...
1 parent a6af1a5 commit f09f526

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

docs/changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Changelog
1717
We expect this to be followed-up on later with more service-specific options
1818
for services like Patreon. Thanks to Melanie Crutchfield for the report and
1919
Steven Loria for the initial patch.
20-
- :bug:`128` Remove Gittip/Gratipay output from the ``donation.html`` sidebar
20+
- :bug:`128` Remove Gittip/Gratipay output from the ``donate.html`` sidebar
2121
component, since the actual service has been insolvent since 2017. The
2222
configuration options remain in place for the time being (to avoid breaking
2323
backwards compatibility) but no longer do anything. Thanks to Joe Alcorn for
@@ -29,7 +29,7 @@ Changelog
2929

3030
- :feature:`142 backported` Add a ``tidelift_url`` option, which when set
3131
(default is ``None``/unset) adds a small text snippet to the
32-
``donation.html`` sidebar component, linking to the given URL string. Thanks
32+
``donate.html`` sidebar component, linking to the given URL string. Thanks
3333
to Steven Loria for the patch.
3434
- :bug:`141` Fix a typo in the code-block font family, which incorrectly
3535
specified ``Deja Vu Sans Mono`` instead of ``DejaVu Sans Mono``. This would

docs/customization.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ banners.
118118
settings.
119119
* ``donate_url``: URL to generic/arbitrary donation service; causes display of
120120
a basic 'Donate' badge/shield (from https://shields.io) linking to the URL
121-
given. Requires ``donation.html`` in your ``html_sidebars``.
121+
given.
122122
* ``github_banner``: ``true`` or ``false`` - whether to apply a 'Fork me on
123123
Github' banner in the top right corner of the page.
124124

@@ -146,7 +146,6 @@ banners.
146146
* ``tidelift_url``: Set this to your `Tidelift <https://tidelift.com/>`_
147147
project URL if you want a "Professional support" section in your sidebar.
148148

149-
- Requires ``donation.html`` to be enabled in your ``html_sidebars`` option.
150149
- If copying the URL straight from Tidelift's site, you'll probably want to
151150
change ``&utm_campaign=readme`` to ``&utm_campaign=docs``.
152151

0 commit comments

Comments
 (0)