##// END OF EJS Templates
docs: cleanup of casing, markup and spacing of headings...
Mads Kiilerich -
r5413:22a3fa3c default
parent child Browse files
Show More
@@ -45,8 +45,7 b' The issue tracker and a repository mirro'
45 45 https://bitbucket.org/conservancy/kallithea.
46 46
47 47
48
49 Kallithea Features
48 Kallithea features
50 49 ------------------
51 50
52 51 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each
@@ -162,7 +161,7 b' database:'
162 161 - keep the database unconverted (intended for testing and evaluation)
163 162 - convert the database in a one-time step
164 163
165 Maintaining Interoperability
164 Maintaining interoperability
166 165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167 166
168 167 Interoperability with RhodeCode 2.2.X installations is provided so you don't
@@ -181,7 +180,7 b' via::'
181 180 then you will find this location at
182 181 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
183 182
184 One-time Conversion
183 One-time conversion
185 184 ~~~~~~~~~~~~~~~~~~~
186 185
187 186 Alternatively, if you would like to convert the database for good, you can use
@@ -1,7 +1,7 b''
1 1 .. _models:
2 2
3 3 ========================
4 The :mod:`models` Module
4 The :mod:`models` module
5 5 ========================
6 6
7 7 .. automodule:: kallithea.model
@@ -1,7 +1,9 b''
1 1 .. _index:
2 2
3 #######################
3 4 Kallithea Documentation
4 -----------------------
5 #######################
6
5 7
6 8 **Readme**
7 9
@@ -32,7 +34,7 b' Kallithea Documentation'
32 34 usage/locking
33 35 usage/statistics
34 36
35 **Administrators Guide**
37 **Administrator's guide**
36 38
37 39 .. toctree::
38 40 :maxdepth: 1
@@ -43,7 +45,7 b' Kallithea Documentation'
43 45 usage/debugging
44 46 usage/troubleshooting
45 47
46 **Develop**
48 **Development**
47 49
48 50 .. toctree::
49 51 :maxdepth: 1
@@ -107,7 +107,7 b' To install as a regular user in ``~/.loc'
107 107 You can now proceed to :ref:`setup`.
108 108
109 109 Upgrading Kallithea from Python Package Index (PyPI)
110 -----------------------------------------------------
110 ----------------------------------------------------
111 111
112 112 .. note::
113 113 It is strongly recommended that you **always** perform a database and
@@ -1,5 +1,6 b''
1 1 .. _installation_iis:
2 2
3 =====================================================================
3 4 Installing Kallithea on Microsoft Internet Information Services (IIS)
4 5 =====================================================================
5 6
@@ -24,7 +25,7 b' The following will assume that your Kall'
24 25 will be served from the root of its own website. The changes to serve it in its
25 26 own virtual folder will be noted where appropriate.
26 27
27 Application Pool
28 Application pool
28 29 ................
29 30
30 31 Make sure that there is a unique application pool for the Kallithea application
@@ -41,7 +42,7 b' to run on the website and consequently, '
41 42 as the requirements to Kallithea are enabled by the existing application
42 43 pool.
43 44
44 ISAPI Handler
45 ISAPI handler
45 46 .............
46 47
47 48 The ISAPI handler can be generated using::
@@ -1,6 +1,6 b''
1 1 .. _installation_win:
2 2
3
3 ================================================================
4 4 Installation and upgrade on Windows (7/Server 2008 R2 and newer)
5 5 ================================================================
6 6
@@ -88,7 +88,7 b' open a CMD and type::'
88 88 SETX PATH "%PATH%;[your-python-path]\Scripts" /M
89 89
90 90
91 Step 5 - Kallithea Folder Structure
91 Step 5 - Kallithea folder structure
92 92 -----------------------------------
93 93
94 94 Create a Kallithea folder structure.
@@ -151,7 +151,7 b' The prompt will change into "(Env) C:\\\\K'
151 151 normal.
152 152
153 153
154 Step 8 - (Optional) Install git
154 Step 8 - Install git (optional)
155 155 -------------------------------
156 156
157 157 Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
@@ -1,10 +1,10 b''
1 1 .. _installation_win_old:
2 2
3
3 ======================================================================
4 4 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
5 5 ======================================================================
6 6
7 First time install
7 First-time install
8 8 ::::::::::::::::::
9 9
10 10 Target OS: Windows XP SP3 32bit English (Clean installation)
@@ -21,8 +21,8 b' Target OS: Windows XP SP3 32bit English '
21 21 - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
22 22 - http://bugs.python.org/issue7511
23 23
24 Step1 - Install Visual Studio 2008 Express
25 ------------------------------------------
24 Step 1 - Install Visual Studio 2008 Express
25 -------------------------------------------
26 26
27 27
28 28 Optional: You can also install MinGW, but VS2008 installation is easier.
@@ -57,8 +57,8 b' choose "Visual C++ 2008 Express" when in'
57 57 Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
58 58
59 59
60 Step2 - Install Python
61 ----------------------
60 Step 2 - Install Python
61 -----------------------
62 62
63 63 Install Python 2.x.y (x = 6 or 7) x86 version (32bit). DO NOT USE A 3.x version.
64 64 Download Python 2.x.y from:
@@ -73,8 +73,8 b' be needed in the next step. In this case'
73 73
74 74 64bit: Just download and install the 64bit version of python.
75 75
76 Step3 - Install Win32py extensions
77 ----------------------------------
76 Step 3 - Install Win32py extensions
77 -----------------------------------
78 78
79 79 Download pywin32 from:
80 80 http://sourceforge.net/projects/pywin32/files/
@@ -92,8 +92,8 b' http://sourceforge.net/projects/pywin32/'
92 92 At the time of writing you can find this at:
93 93 http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
94 94
95 Step4 - Python BIN
96 ------------------
95 Step 4 - Python BIN
96 -------------------
97 97
98 98 Add Python BIN folder to the path
99 99
@@ -120,8 +120,8 b' that came preinstalled in Vista/7 and ca'
120 120 Typically: C:\\Python27
121 121
122 122
123 Step5 - Kallithea folder structure
124 ----------------------------------
123 Step 5 - Kallithea folder structure
124 -----------------------------------
125 125
126 126 Create a Kallithea folder structure
127 127
@@ -138,7 +138,7 b' Create the following folder structure::'
138 138 C:\Kallithea\Repos
139 139
140 140
141 Step6 - Install virtualenv
141 Step 6 - Install virtualenv
142 142 ---------------------------
143 143
144 144 Install Virtual Env for Python
@@ -159,8 +159,8 b' where you downloaded "virtualenv.py", an'
159 159 to include it)
160 160
161 161
162 Step7 - Install Kallithea
163 -------------------------
162 Step 7 - Install Kallithea
163 --------------------------
164 164
165 165 Finally, install Kallithea
166 166
@@ -198,8 +198,8 b' The prompt will change into "(Env) C:\\\\K'
198 198 Some warnings will appear, don't worry as they are normal.
199 199
200 200
201 Step8 - Configuring Kallithea
202 -----------------------------
201 Step 8 - Configuring Kallithea
202 ------------------------------
203 203
204 204
205 205 steps taken from http://packages.python.org/Kallithea/setup.html
@@ -238,8 +238,8 b' If you make some mistake and the script '
238 238 it again.
239 239
240 240
241 Step9 - Running Kallithea
242 -------------------------
241 Step 9 - Running Kallithea
242 --------------------------
243 243
244 244
245 245 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
@@ -1,7 +1,7 b''
1 1 .. _overview:
2 2
3 3 =====================
4 Installation Overview
4 Installation overview
5 5 =====================
6 6
7 7
@@ -9,7 +9,7 b' Some overview and some details that can '
9 9 installing Kallithea.
10 10
11 11
12 Python Environment
12 Python environment
13 13 ------------------
14 14
15 15 **Kallithea** is written entirely in Python_ and requires Python version
@@ -38,7 +38,7 b' environment used for running Kallithea.'
38 38 We recommend using virtualenv for installing Kallithea.
39 39
40 40
41 Installation Methods
41 Installation methods
42 42 --------------------
43 43
44 44 Kallithea must be installed on a server. Kallithea is installed in a Python
@@ -71,7 +71,7 b' installed.'
71 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 77 Kallithea is (primarily) a WSGI_ application that must be run from a web
@@ -440,7 +440,8 b' reverse-proxy setup with basic auth::'
440 440 forge the authentication header and could effectively become authenticated
441 441 using any account of their liking.
442 442
443 Integration with Issue trackers
443
444 Integration with issue trackers
444 445 -------------------------------
445 446
446 447 Kallithea provides a simple integration with issue trackers. It's possible
@@ -63,6 +63,7 b' you could set up a local forwarding SMTP'
63 63
64 64 References
65 65 ----------
66
66 67 - `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_
67 68 - `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_
68 69
@@ -161,7 +161,7 b' into repositories, e.g., defining a ``re'
161 161 about a manager of each repository. There's no limit for adding custom fields.
162 162 Newly created fields are accessible via the API.
163 163
164 Meta-Tagging
164 Meta tagging
165 165 ~~~~~~~~~~~~
166 166
167 167 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea
@@ -1,7 +1,7 b''
1 1 .. _performance:
2 2
3 3 ================================
4 Optimizing Kallithea Performance
4 Optimizing Kallithea performance
5 5 ================================
6 6
7 7 When serving a large amount of big repositories, Kallithea can start
@@ -1,6 +1,5 b''
1 1 .. _troubleshooting:
2 2
3
4 3 ===============
5 4 Troubleshooting
6 5 ===============
General Comments 0
You need to be logged in to leave comments. Login now