From a68938bdc69a3329e6ebf29efd84d365386af3e7 Mon Sep 17 00:00:00 2001 From: medmunds Date: Wed, 22 Jul 2020 13:41:52 -0700 Subject: [PATCH] Docs: add shell quoting to install commands In docs install examples, show double quotes around package specifiers that include square brackets, to prevent them from being interpreted as shell globs. (Helps with installation on Windows and zsh, e.g.) Closes #188 --- README.rst | 2 +- docs/esps/amazon_ses.rst | 2 +- docs/esps/sparkpost.rst | 2 +- docs/installation.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 5813632..5e352cb 100644 --- a/README.rst +++ b/README.rst @@ -77,7 +77,7 @@ or SparkPost or any other supported ESP where you see "mailgun": .. code-block:: console - $ pip install django-anymail[mailgun] + $ pip install "django-anymail[mailgun]" (The `[mailgun]` part installs any additional packages needed for that ESP. Mailgun doesn't have any, but some other ESPs do.) diff --git a/docs/esps/amazon_ses.rst b/docs/esps/amazon_ses.rst index e80d40f..174ec2f 100644 --- a/docs/esps/amazon_ses.rst +++ b/docs/esps/amazon_ses.rst @@ -27,7 +27,7 @@ backend. Either include the "amazon_ses" option when you install Anymail: .. code-block:: console - $ pip install django-anymail[amazon_ses] + $ pip install "django-anymail[amazon_ses]" or separately run `pip install boto3`. diff --git a/docs/esps/sparkpost.rst b/docs/esps/sparkpost.rst index 80ea9a0..2470ca2 100644 --- a/docs/esps/sparkpost.rst +++ b/docs/esps/sparkpost.rst @@ -17,7 +17,7 @@ backend. Either include the "sparkpost" option when you install Anymail: .. code-block:: console - $ pip install django-anymail[sparkpost] + $ pip install "django-anymail[sparkpost]" or separately run `pip install sparkpost`. diff --git a/docs/installation.rst b/docs/installation.rst index 2067a22..88bd0a3 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -12,7 +12,7 @@ To use Anymail in your Django project: .. code-block:: console - $ pip install django-anymail[sendgrid,sparkpost] + $ pip install "django-anymail[sendgrid,sparkpost]" The `[sendgrid,sparkpost]` part of that command tells pip you also want to install additional packages required for those ESPs.