mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
Docs: simplify PyPI links
Use `:pypi:` sphinx-ext-extlink role for links to PyPI, and add some missing package links.
This commit is contained in:
@@ -35,7 +35,7 @@ needs_sphinx = '1.0'
|
|||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.intersphinx']
|
extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.extlinks']
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
@@ -256,6 +256,11 @@ texinfo_documents = [
|
|||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
# texinfo_show_urls = 'footnote'
|
# texinfo_show_urls = 'footnote'
|
||||||
|
|
||||||
|
# -- Options for extlinks ---------------------------------------------------
|
||||||
|
|
||||||
|
extlinks = {
|
||||||
|
'pypi': ('https://pypi.python.org/pypi/%s', ''),
|
||||||
|
}
|
||||||
|
|
||||||
# -- Options for Intersphinx ------------------------------------------------
|
# -- Options for Intersphinx ------------------------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -20,8 +20,7 @@ transactional email service from MailChimp.
|
|||||||
|
|
||||||
If you are integrating only Mandrill, and not considering one of Anymail's
|
If you are integrating only Mandrill, and not considering one of Anymail's
|
||||||
other ESPs, you might prefer using MailChimp's official
|
other ESPs, you might prefer using MailChimp's official
|
||||||
`mandrill <https://pypi.python.org/pypi/mandrill/>`_ python package
|
:pypi:`mandrill` python package instead of Anymail.
|
||||||
instead of Anymail.
|
|
||||||
|
|
||||||
|
|
||||||
Settings
|
Settings
|
||||||
|
|||||||
@@ -4,16 +4,15 @@ SparkPost
|
|||||||
=========
|
=========
|
||||||
|
|
||||||
Anymail integrates with the `SparkPost`_ email service, using their
|
Anymail integrates with the `SparkPost`_ email service, using their
|
||||||
`python-sparkpost`_ API client.
|
:pypi:`python-sparkpost` API client.
|
||||||
|
|
||||||
.. _SparkPost: https://www.sparkpost.com/
|
.. _SparkPost: https://www.sparkpost.com/
|
||||||
.. _python-sparkpost: https://pypi.python.org/pypi/sparkpost
|
|
||||||
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
You must ensure the `sparkpost` package is installed to use Anymail's SparkPost
|
You must ensure the :pypi:`sparkpost` package is installed to use Anymail's SparkPost
|
||||||
backend. Either include the "sparkpost" option when you install Anymail:
|
backend. Either include the "sparkpost" option when you install Anymail:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|||||||
@@ -468,7 +468,7 @@ AnymailMessageMixin
|
|||||||
Mixin class that adds Anymail's ESP extra attributes and convenience methods
|
Mixin class that adds Anymail's ESP extra attributes and convenience methods
|
||||||
to other :class:`~django.core.mail.EmailMessage` subclasses.
|
to other :class:`~django.core.mail.EmailMessage` subclasses.
|
||||||
|
|
||||||
For example, with the `django-mail-templated`_ package's custom EmailMessage:
|
For example, with the :pypi:`django-mail-templated` package's custom EmailMessage:
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
@@ -489,6 +489,3 @@ AnymailMessageMixin
|
|||||||
)
|
)
|
||||||
msg.context = {"order_num": "12345"} # Mail-Templated attribute
|
msg.context = {"order_num": "12345"} # Mail-Templated attribute
|
||||||
msg.tags = ["templated"] # Anymail attribute
|
msg.tags = ["templated"] # Anymail attribute
|
||||||
|
|
||||||
|
|
||||||
.. _django-mail-templated: https://pypi.python.org/pypi/django-mail-templated
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ Anymail supports most of the functionality of Django's :class:`~django.core.mail
|
|||||||
and :class:`~django.core.mail.EmailMultiAlternatives` classes.
|
and :class:`~django.core.mail.EmailMultiAlternatives` classes.
|
||||||
|
|
||||||
Anymail handles **all** outgoing email sent through Django's
|
Anymail handles **all** outgoing email sent through Django's
|
||||||
:mod:`django.core.mail` package, including :func:`~django.core.mail.send_mail`,
|
:mod:`django.core.mail` module, including :func:`~django.core.mail.send_mail`,
|
||||||
:func:`~django.core.mail.send_mass_mail`, the :class:`~django.core.mail.EmailMessage` class,
|
:func:`~django.core.mail.send_mass_mail`, the :class:`~django.core.mail.EmailMessage` class,
|
||||||
and even :func:`~django.core.mail.mail_admins`.
|
and even :func:`~django.core.mail.mail_admins`.
|
||||||
If you'd like to selectively send only some messages through Anymail,
|
If you'd like to selectively send only some messages through Anymail,
|
||||||
|
|||||||
@@ -50,6 +50,7 @@ in Django:
|
|||||||
|
|
||||||
.. TODO: flesh this out
|
.. TODO: flesh this out
|
||||||
|
|
||||||
* django-templated-mail, django-mail-templated, django-mail-templated-simple
|
* :pypi:`django-templated-mail`, :pypi:`django-mail-templated`, or :pypi:`django-mail-templated-simple`
|
||||||
* Premailer, for inlining css
|
for building messages from sets of Django templates.
|
||||||
* BeautifulSoup, lxml, or html2text, for auto-generating plaintext from your html
|
* :pypi:`premailer` for inlining css before sending
|
||||||
|
* :pypi:`BeautifulSoup`, :pypi:`lxml`, or :pypi:`html2text` for auto-generating plaintext from your html
|
||||||
|
|||||||
Reference in New Issue
Block a user