Mercurial > kallithea

comparison docs/overview.rst @ 5413:22a3fa3c4254

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: cleanup of casing, markup and spacing of headings Mostly stuff found and fixed by Søren, extracted here to separate things. Other uses of title casing might be debatable, but here it was just a few documentation headings that clearly were inconsistent with the majority.
author Mads Kiilerich <madski@unity3d.com>
date Thu, 20 Aug 2015 03:26:18 +0200
parents 154becd92f40
children 36a35394b3cb
comparison
equal deleted inserted replaced
5412:2079e864ce51 5413:22a3fa3c4254
1 .. _overview: 1 .. _overview:
2 2
3 ===================== 3 =====================
4 Installation Overview 4 Installation overview
5 ===================== 5 =====================
6 6
7 7
8 Some overview and some details that can help understanding the options when 8 Some overview and some details that can help understanding the options when
9 installing Kallithea. 9 installing Kallithea.
10 10
11 11
12 Python Environment 12 Python environment
13 ------------------ 13 ------------------
14 14
15 **Kallithea** is written entirely in Python_ and requires Python version 15 **Kallithea** is written entirely in Python_ and requires Python version
16 2.6 or higher. Python 3.x is currently not supported. 16 2.6 or higher. Python 3.x is currently not supported.
17 17
36 self-contained virtual environment. 36 self-contained virtual environment.
37 37
38 We recommend using virtualenv for installing Kallithea. 38 We recommend using virtualenv for installing Kallithea.
39 39
40 40
41 Installation Methods 41 Installation methods
42 -------------------- 42 --------------------
43 43
44 Kallithea must be installed on a server. Kallithea is installed in a Python 44 Kallithea must be installed on a server. Kallithea is installed in a Python
45 environment so it can use packages that are installed there and make itself 45 environment so it can use packages that are installed there and make itself
46 available for other packages. 46 available for other packages.
69 69
70 (``pip install kallithea`` from a source tree will do pretty much the same 70 (``pip install kallithea`` from a source tree will do pretty much the same
71 but build the Kallithea package itself locally instead of downloading it.) 71 but build the Kallithea package itself locally instead of downloading it.)
72 72
73 73
74 Web Server 74 Web server
75 ---------- 75 ----------
76 76
77 Kallithea is (primarily) a WSGI_ application that must be run from a web 77 Kallithea is (primarily) a WSGI_ application that must be run from a web
78 server that expose WSGI as HTTP. 78 server that expose WSGI as HTTP.
79 79