changeset 7842:3a3d96dbd445

docs: clean up installation of optional dependencies Install them together with Kallithea, to make things simpler, and make sure all constraints are handled correctly.
author Mads Kiilerich <mads@kiilerich.com>
date Mon, 12 Aug 2019 12:54:01 +0200
parents d9e37f7fd35b
children e2e5140704fc
files docs/contributing.rst docs/installation.rst
diffstat 2 files changed, 10 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/docs/contributing.rst	Mon Aug 12 12:54:01 2019 +0200
+++ b/docs/contributing.rst	Mon Aug 12 12:54:01 2019 +0200
@@ -35,7 +35,7 @@
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
         pip install --upgrade pip setuptools
-        pip install --upgrade -e . -r dev_requirements.txt
+        pip install --upgrade -e . -r dev_requirements.txt python-ldap python-pam
         kallithea-cli config-create my.ini
         kallithea-cli db-create -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
         kallithea-cli front-end-build
--- a/docs/installation.rst	Mon Aug 12 12:54:01 2019 +0200
+++ b/docs/installation.rst	Mon Aug 12 12:54:01 2019 +0200
@@ -88,15 +88,6 @@
    will "activate" a shell that terminates immediately. It is also perfectly
    acceptable (and desirable) to create a virtualenv as a normal user.
 
-.. note:: Some dependencies are optional. If you need them, install them in
-   the virtualenv too::
-
-     pip install --upgrade psycopg2
-     pip install --upgrade python-ldap
-
-   This might require installation of development packages using your
-   distribution's package manager.
-
 - Make a folder for Kallithea data files, and configuration somewhere on the
   filesystem. For example::
 
@@ -106,8 +97,16 @@
 
     pip install --upgrade kallithea
 
+.. note:: Some dependencies are optional. If you need them, install them in
+   the virtualenv too::
+
+     pip install --upgrade kallithea python-ldap python-pam psycopg2
+
+   This might require installation of development packages using your
+   distribution's package manager.
+
   Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
-  extract it and run::
+  extract it and install from source by running::
 
     pip install --upgrade .