From 78161a0b1b25e3e234411726c4faada9e1ef97be Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 4 Dec 2017 19:17:04 +0100 Subject: [PATCH] doc: make it clear that Python 3 is required by the theme and plugins. --- README.rst | 2 +- doc/pelican.rst | 12 ++++++++---- doc/plugins/htmlsanity.rst | 2 +- doc/plugins/images.rst | 2 +- doc/plugins/math-and-code.rst | 2 +- 5 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index b246bb7a..76b552b3 100644 --- a/README.rst +++ b/README.rst @@ -70,7 +70,7 @@ On Ubuntu you need these: .. code:: sh sudo apt-get install texlive-base texlive-latex-extra texlive-fonts-extra - pip install pelican Pyphen Pillow + pip3 install pelican Pyphen Pillow Once you have all the dependencies, simply go to the ``site/`` subdirectory and start development server there. The live-reloading website will appear on diff --git a/doc/pelican.rst b/doc/pelican.rst index 6fe6770f..e707ec1a 100644 --- a/doc/pelican.rst +++ b/doc/pelican.rst @@ -44,14 +44,18 @@ set of useful plugins. `Quick start`_ ============== -Install Pelican either via ``pip`` or using your system package manager. Note -that in order to use m.css `plugins <{filename}/plugins.rst>`_ later, you may -want to install the Python 3 version. +Install Pelican either via ``pip`` or using your system package manager. + +.. note-danger:: + + In order to use the m.css `theme <{filename}/pelican/theme.rst>`_ or + `plugins <{filename}/plugins.rst>`_ later, you need to install the Python 3 + version of Pelican. Python 2 is not supported. .. code:: sh # You may need sudo here - pip install pelican + pip3 install pelican Note that using the m.css theme or Pelican plugins may require additional dependencies than just Pelican --- documentation of each lists the additional diff --git a/doc/plugins/htmlsanity.rst b/doc/plugins/htmlsanity.rst index 31fff7bb..7ebd32de 100644 --- a/doc/plugins/htmlsanity.rst +++ b/doc/plugins/htmlsanity.rst @@ -64,7 +64,7 @@ it with the above setting. .. code:: sh - pip install Pyphen + pip3 install Pyphen `What it does`_ =============== diff --git a/doc/plugins/images.rst b/doc/plugins/images.rst index 7cf64e63..ef88ede0 100644 --- a/doc/plugins/images.rst +++ b/doc/plugins/images.rst @@ -64,7 +64,7 @@ To use the image grid feature (see below), in addition you need the .. code:: sh - pip install Pillow + pip3 install Pillow `Images, figures`_ ================== diff --git a/doc/plugins/math-and-code.rst b/doc/plugins/math-and-code.rst index f43f5808..494b99c3 100644 --- a/doc/plugins/math-and-code.rst +++ b/doc/plugins/math-and-code.rst @@ -148,7 +148,7 @@ it via ``pip`` or your distribution package manager: .. code:: sh - pip install Pygments + pip3 install Pygments The plugin overrides the builtin docutils `code directive `_ -- 2.30.2