From e5ce678a9336d62eccd26d7531b84362ec071f2d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 11 Dec 2017 15:36:06 +0100 Subject: [PATCH] doc: mention minimal Python versions for theme and plugins. --- doc/pelican.rst | 4 +++- doc/pelican/theme.rst | 7 +++++-- doc/plugins/math-and-code.rst | 5 +++++ 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/doc/pelican.rst b/doc/pelican.rst index e707ec1a..887bdfd1 100644 --- a/doc/pelican.rst +++ b/doc/pelican.rst @@ -50,7 +50,9 @@ Install Pelican either via ``pip`` or using your system package manager. 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. + version of Pelican. Most of the plugins work with Python 3.4, while some + (such as the `math plugin <{filename}/plugins/math-and-code.rst#math>`_) + need 3.5. Python 2 is not supported. .. code:: sh diff --git a/doc/pelican/theme.rst b/doc/pelican/theme.rst index 364094dd..92b03ed0 100644 --- a/doc/pelican/theme.rst +++ b/doc/pelican/theme.rst @@ -46,8 +46,11 @@ or a full product/project/portfolio website where the blog is only a side dish. `Quick start`_ ============== -The easiest way to start is putting the :gh:`whole Git repository ` -of m.css into your project, for example as a submodule: +Following the `Pelican quick start guide <{filename}/pelican.rst#quick-start>`_, +it's assumed you already have at least Python 3.4 and the Python 3 version of +Pelican installed. The easiest way to start is putting the +:gh:`whole Git repository ` of m.css into your project, for +example as a submodule: .. code:: sh diff --git a/doc/plugins/math-and-code.rst b/doc/plugins/math-and-code.rst index 36cb0423..c1f9ae8c 100644 --- a/doc/plugins/math-and-code.rst +++ b/doc/plugins/math-and-code.rst @@ -55,6 +55,11 @@ put them including the ``m/`` directory into one of your :py:`PLUGIN_PATHS` and add :py:`m.math` package to your :py:`PLUGINS` in ``pelicanconf.py``. This plugin assumes presence of `m.htmlsanity <{filename}/plugins/htmlsanity.rst>`_. +.. note-danger:: + + Note that this plugin, unlike most of the others, requires at least Python + 3.5 to run properly. + .. code:: python PLUGINS += ['m.htmlsanity', 'm.math'] -- 2.30.2