summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2014-11-29 18:10:04 +0100
committermathieui <mathieui@mathieui.net>2014-11-29 18:10:04 +0100
commit952a18cf21f69c445344eaed221dd0b4d09bf91b (patch)
treed675b085791c41c726be62aaf93c564041389e96 /doc/source
parent7f0227b7d4a5a00546537bf2b595f3a2969174a5 (diff)
downloadpoezio-952a18cf21f69c445344eaed221dd0b4d09bf91b.tar.gz
poezio-952a18cf21f69c445344eaed221dd0b4d09bf91b.tar.bz2
poezio-952a18cf21f69c445344eaed221dd0b4d09bf91b.tar.xz
poezio-952a18cf21f69c445344eaed221dd0b4d09bf91b.zip
Add a documentation page for pyenv
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/install.rst8
-rw-r--r--doc/source/misc/index.rst1
-rw-r--r--doc/source/misc/pyenv.rst24
3 files changed, 30 insertions, 3 deletions
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 0ffa9883..d21831b1 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -1,7 +1,8 @@
Installing poezio
=================
-.. important:: Python 3.4 or above is **required**
+.. warning:: Python 3.4 or above is **required**.
+ To install it on a distribution that doesn't provide it, see :ref:`pyenv <pyenv-install>`.
poezio in the GNU/Linux distributions
-------------------------------------
@@ -76,7 +77,7 @@ packaging management.
If you don’t want to use the update script for whatever reason, install the
following dependencies by hand; otherwise, skip to the
-`installation part <poezio-install-label>`.
+:ref:`installation part <poezio-install-label>`.
""""""""
@@ -87,7 +88,7 @@ Poezio depends on slixmpp, a non-thread fork of the SleekXMPP library.
.. code-block:: bash
- git clone git://git.louiz.org/slixmpp
+ git clone git://git.poez.io/slixmpp
python3 setup.py install --user
@@ -159,3 +160,4 @@ If you did, it should be in he ``$PATH`` as ``poezio``, so run:
.. _poezio-git: https://aur.archlinux.org/packages/poezio-git/
.. _up-to-date package: https://apps.fedoraproject.org/packages/poezio
.. _pypi: https://pypi.python.org/pypi/poezio
+
diff --git a/doc/source/misc/index.rst b/doc/source/misc/index.rst
index 08349437..fe8f1100 100644
--- a/doc/source/misc/index.rst
+++ b/doc/source/misc/index.rst
@@ -9,6 +9,7 @@ Contents:
carbons
correct
personal_events
+ pyenv
separate
ssl
troubleshooting
diff --git a/doc/source/misc/pyenv.rst b/doc/source/misc/pyenv.rst
new file mode 100644
index 00000000..42f8c208
--- /dev/null
+++ b/doc/source/misc/pyenv.rst
@@ -0,0 +1,24 @@
+.. _pyenv-install:
+
+Pyenv - Installing python 3.4 as an user
+========================================
+
+Pyenv_ is a useful script that allows you to install several python versions
+in your user directory, and lets you manage which one you want depending on
+the directory you are in. It is therefore useful for people who are on
+distributions not providing the latest stable version, such as Debian or
+CentOS.
+
+You can follow the step-by-step `installation tutorial`_ on github that will
+help you install it to your home directory (on step 5, you should use 3.4.2
+which is the latest python 3.4 release at the time of writing this page); or
+you can use the `automated installer`_ and use ``pyenv install 3.4.2``
+thereafter.
+
+Then you only need to add a ``.python-version`` file containing ``3.4.2`` in
+your poezio directory to make the python version in that directory default to
+the python 3.4.2 installed with pyenv.
+
+.. _Pyenv: https://github.com/yyuu/pyenv
+.. _installation tutorial: https://github.com/yyuu/pyenv#installation
+.. _automated installer: https://github.com/yyuu/pyenv-installer