Skip to content

Commit 5c2f2fd

Browse files
committed
Docs: add notes to esp-feature-matrix
Use footnotes to clarify some details in the supported features table. Closes #377
1 parent f355bd5 commit 5c2f2fd

File tree

4 files changed

+32
-7
lines changed

4 files changed

+32
-7
lines changed

docs/_static/anymail-theme.css

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,19 @@ table.sticky-left th:first-of-type[colspan] > p {
1717
left: 17px; /* (.wy-table $table-padding-size) + (docutils border="1" in html) */
1818
}
1919

20+
/* Fix footnote stacking in sticky table */
21+
.rst-content .citation-reference,
22+
.rst-content .footnote-reference {
23+
/* Original (but `position: relative` creates a new stacking context):
24+
vertical-align: baseline;
25+
position: relative;
26+
top: -.4em;
27+
*/
28+
vertical-align: 0.4em;
29+
position: static;
30+
top: initial; /* (not relevant with `position: static`) */
31+
}
32+
2033
/* Show code cross-reference links as clickable $link-color (blue).
2134
2235
Sphinx-rtd-theme usually wants `.rst-content a code` to be $link-color [1], but has

docs/docutils.conf

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[general]
2+
footnote_backlinks: false
3+
trim_footnote_reference_space: true
4+
5+
[html writers]
6+
footnote_references: superscript

docs/esps/esp-feature-matrix.csv

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
Email Service Provider,:ref:`amazon-ses-backend`,:ref:`brevo-backend`,:ref:`mailersend-backend`,:ref:`mailgun-backend`,:ref:`mailjet-backend`,:ref:`mandrill-backend`,:ref:`postal-backend`,:ref:`postmark-backend`,:ref:`resend-backend`,:ref:`sendgrid-backend`,:ref:`sparkpost-backend`,:ref:`unisender-go-backend`
22
.. rubric:: :ref:`Anymail send options <anymail-send-options>`,,,,,,,,,,,,
33
:attr:`~AnymailMessage.envelope_sender`,Yes,No,No,Domain only,Yes,Domain only,Yes,No,No,No,Yes,No
4-
:attr:`~AnymailMessage.merge_headers`,Yes*,Yes,No,Yes,Yes,No,No,Yes,Yes,Yes,Yes*,Yes*
4+
:attr:`~AnymailMessage.merge_headers`,Yes [#caveats]_,Yes,No,Yes,Yes,No,No,Yes,Yes,Yes,Yes [#caveats]_,Yes [#caveats]_
55
:attr:`~AnymailMessage.metadata`,Yes,Yes,No,Yes,Yes,Yes,No,Yes,Yes,Yes,Yes,Yes
6-
:attr:`~AnymailMessage.merge_metadata`,Yes*,Yes,No,Yes,Yes,Yes,No,Yes,Yes,Yes,Yes,Yes
6+
:attr:`~AnymailMessage.merge_metadata`,Yes [#caveats]_,Yes,No,Yes,Yes,Yes,No,Yes,Yes,Yes,Yes,Yes
77
:attr:`~AnymailMessage.send_at`,No,Yes,Yes,Yes,No,Yes,No,No,No,Yes,Yes,Yes
88
:attr:`~AnymailMessage.tags`,Yes,Yes,Yes,Yes,Max 1 tag,Yes,Max 1 tag,Max 1 tag,Yes,Yes,Max 1 tag,Yes
9-
:attr:`~AnymailMessage.track_clicks`,No,No,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
10-
:attr:`~AnymailMessage.track_opens`,No,No,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
9+
:attr:`~AnymailMessage.track_clicks`,No [#nocontrol]_,No [#nocontrol]_,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
10+
:attr:`~AnymailMessage.track_opens`,No [#nocontrol]_,No [#nocontrol]_,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
1111
:ref:`amp-email`,Yes,No,No,Yes,No,No,No,No,No,Yes,Yes,Yes
1212
.. rubric:: :ref:`templates-and-merge`,,,,,,,,,,,,
1313
:attr:`~AnymailMessage.template_id`,Yes,Yes,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
14-
:attr:`~AnymailMessage.merge_data`,Yes*,Yes,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
15-
:attr:`~AnymailMessage.merge_global_data`,Yes*,Yes,(emulated),(emulated),Yes,Yes,No,Yes,No,Yes,Yes,Yes
14+
:attr:`~AnymailMessage.merge_data`,Yes [#caveats]_,Yes,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
15+
:attr:`~AnymailMessage.merge_global_data`,Yes [#caveats]_,Yes,Yes,Yes,Yes,Yes,No,Yes,No,Yes,Yes,Yes
1616
.. rubric:: :ref:`Status <esp-send-status>` and :ref:`event tracking <event-tracking>`,,,,,,,,,,,,
1717
:attr:`~AnymailMessage.anymail_status`,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes
1818
:class:`~anymail.signals.AnymailTrackingEvent` from webhooks,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes,Yes

docs/esps/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,13 @@ The table below summarizes the Anymail features supported for each ESP.
4848
:widths: auto
4949
:class: sticky-left
5050

51-
\* See ESP detail page for limitations and clarifications
51+
.. [#caveats]
52+
Some restrictions apply---see the ESP detail page
53+
(usually under "Limitations and Quirks").
54+
55+
.. [#nocontrol]
56+
The ESP supports tracking, but Anymail can't enable/disable it
57+
for individual messages. See the ESP detail page for more information.
5258
5359
Trying to choose an ESP? Please **don't** start with this table. It's far more
5460
important to consider things like an ESP's deliverability stats, latency, uptime,

0 commit comments

Comments
 (0)