Added a temporary version warning to the docs.

epsy · Apr 25, 2015 · 8fdd3b1 · 8fdd3b1
1 parent 6bde8a0
commit 8fdd3b1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/basics.rst b/docs/basics.rst
@@ -31,6 +31,14 @@ If you wish to do a user-wide install:
 
     pip install --user clize
 
+.. warning::
+
+    These docs refer to an in-development version of clize. The instructions here will NOT work on the latest stable version, Clize 2.4. You can use the following command to install a compatible version:
+
+    .. code-block:: console
+
+        $ pip install --user --pre 'clize<=3'
+
 
 A minimal application
 ---------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,13 @@ Clize is an argument parser for `Python <https://www.python.org/>`_:
 * Reuse functionality through Python decorators
 * Extend it to suit unusual kinds of parameters
 
+.. warning::
+
+    These docs refer to an in-development version of clize. The instructions here will NOT work on the latest stable version, Clize 2.4. You can use the following command to install a compatible version:
+
+    .. code-block:: console
+
+        $ pip install --user --pre 'clize<=3'
 
 .. rubric:: Example