chiark / gitweb /
doc: mention minimal Python versions for theme and plugins.
authorVladimír Vondruš <mosra@centrum.cz>
Mon, 11 Dec 2017 14:36:06 +0000 (15:36 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Mon, 11 Dec 2017 15:18:10 +0000 (16:18 +0100)
doc/pelican.rst
doc/pelican/theme.rst
doc/plugins/math-and-code.rst

index e707ec1a57faa4ba48e1c91ad2433e2fe8d0f721..887bdfd12ceef423c3189e515d1e9a6b01d02750 100644 (file)
@@ -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
 
index 364094dde733dd8084e2feba1bdba3d1febaaf03..92b03ed09faf07d66be5fcf1a272c74525375dec 100644 (file)
@@ -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 <mosra/m.css>`
-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 <mosra/m.css>` of m.css into your project, for
+example as a submodule:
 
 .. code:: sh
 
index 36cb042306bd4e381e34a5d2b9d605561fea1faf..c1f9ae8c32ba532736043ab333d26662572d74a0 100644 (file)
@@ -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']