From 863421b1b8fbd352dbf34d1b66d9dfd0494c5fd2 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Mon, 17 Aug 2020 06:45:38 +0200 Subject: [PATCH] Use more reliable installation command in docs Some shell environments may interpret brackets as glob patterns. Wrapping the argument in quotation marks should help ensure correct behavior in those environments. Refs #2786 --- docs/install.rst | 4 ++-- docs/quickstart.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 03480e79..bf2647ad 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -11,7 +11,7 @@ You can install Pelican via several different methods. The simplest is via Or, if you plan on using Markdown:: - pip install pelican[Markdown] + pip install "pelican[markdown]" (Keep in mind that operating systems will often require you to prefix the above command with ``sudo`` in order to install Pelican system-wide.) @@ -46,7 +46,7 @@ Optional packages If you plan on using `Markdown `_ as a markup format, you can install Pelican with Markdown support:: - pip install pelican[Markdown] + pip install "pelican[markdown]" Or you might need to install it a posteriori:: diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 1f6358a7..8d6d6a5b 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -11,7 +11,7 @@ Install Pelican (and optionally Markdown if you intend to use it) on Python 2.7.x or Python 3.5+ by running the following command in your preferred terminal, prefixing with ``sudo`` if permissions warrant:: - pip install pelican[Markdown] + pip install "pelican[markdown]" Create a project ----------------