Mercurial > kallithea

annotate docs/index.rst @ 5779:60f9840c8df1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: document Kallithea customization options Create basic documentation for the various customization options in Kallithea. Move the rcextensions section to this new page and reword.
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Mon, 14 Mar 2016 22:13:19 +0100
parents ed2fb6e84a02
children 4d5900346144
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
1 .. _index:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
2
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5412
diff changeset
3 #######################
4975
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
4 Kallithea Documentation
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5412
diff changeset
5 #######################
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5412
diff changeset
6
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4815
diff changeset
7 **Readme**
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 642
diff changeset
8
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4815
diff changeset
9 .. toctree::
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4815
diff changeset
10 :maxdepth: 1
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
11
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4815
diff changeset
12 readme
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4815
diff changeset
13
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4815
diff changeset
14 **Installation**
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
15
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
16 .. toctree::
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
17 :maxdepth: 1
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
18
5081
154becd92f40 docs: add installation overview section
Mads Kiilerich <madski@unity3d.com>
parents: 4975
diff changeset
19 overview
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
20 installation
4815
64b1a2320bcb docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Denis Blanchette <dblanchette@coveo.com>
parents: 4814
diff changeset
21 installation_win
4814
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs
Mads Kiilerich <madski@unity3d.com>
parents: 4500
diff changeset
22 installation_win_old
4500
e69d34136be5 docs: describe installation under IIS
Henrik Stuart <hg@hstuart.dk>
parents: 4226
diff changeset
23 installation_iis
744
3389f272ece1 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 717
diff changeset
24 setup
5494
57caeb60c52b docs: add documentation for setup with puppet
Robert Rauch <mail@robertrauch.de>
parents: 5433
diff changeset
25 installation_puppet
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3073
diff changeset
26
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
27 **Usage**
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
28
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
29 .. toctree::
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
30 :maxdepth: 1
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
31
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 811
diff changeset
32 usage/general
4970
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4902
diff changeset
33 usage/vcs_support
2726
aa17c7a1b8a5 Implemented basic locking functionality.
Marcin Kuzminski <marcin@python-works.com>
parents: 2601
diff changeset
34 usage/locking
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 811
diff changeset
35 usage/statistics
4975
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
36
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5412
diff changeset
37 **Administrator's guide**
4975
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
38
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
39 .. toctree::
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
40 :maxdepth: 1
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
41
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 5366
diff changeset
42 usage/email
4975
beb4cbf30d00 docs: create separate 'Administrator guide'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
43 usage/performance
1104
af371e206ec5 added backup to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1025
diff changeset
44 usage/backup
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents: 2023
diff changeset
45 usage/debugging
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2517
diff changeset
46 usage/troubleshooting
5779
60f9840c8df1 docs: document Kallithea customization options
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 5575
diff changeset
47 usage/customization
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents: 2023
diff changeset
48
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5412
diff changeset
49 **Development**
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
50
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
51 .. toctree::
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
52 :maxdepth: 1
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3073
diff changeset
53
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
54 contributing
585
42a87338035a Version bump.
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
55 changelog
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
56
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
57 **API**
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
58
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
59 .. toctree::
1839
9da24750f563 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
60 :maxdepth: 1
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
61
2022
b43a121f3137 more docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
62 api/api
b43a121f3137 more docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
63 api/models
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3073
diff changeset
64
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
65
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
66 Other topics
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5494
diff changeset
67 ************
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
68
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
69 * :ref:`genindex`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
70 * :ref:`search`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
71
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 5413
diff changeset
72
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
73 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
74 .. _python: http://www.python.org/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
75 .. _django: http://www.djangoproject.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
76 .. _mercurial: http://mercurial.selenic.com/
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1104
diff changeset
77 .. _bitbucket: http://bitbucket.org/
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
78 .. _subversion: http://subversion.tigris.org/
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
79 .. _git: http://git-scm.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
80 .. _celery: http://celeryproject.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
81 .. _Sphinx: http://sphinx.pocoo.org/
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3073
diff changeset
82 .. _vcs: http://pypi.python.org/pypi/vcs