##// END OF EJS Templates
docs update
marcink -
r1839:9da24750 beta
parent child Browse files
Show More
@@ -1,6 +1,6 b''
1 =================================================
2 Welcome to RhodeCode (RhodiumCode) documentation!
3 =================================================
1 ========================
2 RhodeCode documentation!
3 ========================
4 4
5 5 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
6 6 with a built in push/pull server and full text search.
@@ -102,7 +102,6 b' Incoming / Plans'
102 102 - pull requests and web based merges
103 103 - per line file history
104 104 - SSH based authentication with server side key management
105 - Redmine and other bugtrackers integration
106 105 - Commit based built in wiki system
107 106 - More statistics and graph (global annotation + some more statistics)
108 107 - Other advancements as development continues (or you can of course make
@@ -10,6 +10,8 b" There's a single schema for calling all "
10 10 with JSON protocol both ways. An url to send API request in RhodeCode is
11 11 <your_server>/_admin/api
12 12
13 API ACCESS FOR WEB VIEWS
14 ++++++++++++++++++++++++
13 15
14 16 API access can also be turned on for each view decorated with `@LoginRequired`
15 17 decorator. To enable API access simple change standard login decorator into
@@ -18,6 +20,9 b' by adding a GET parameter to url `?api_k'
18 20 enabled on RSS/ATOM feed views.
19 21
20 22
23 API ACCESS
24 ++++++++++
25
21 26 All clients are required to send JSON-RPC spec JSON data::
22 27
23 28 {
@@ -1,4 +1,4 b''
1 .. _api:
1 .. _indexapi:
2 2
3 3 API Reference
4 4 =============
@@ -6,14 +6,29 b' The :mod:`models` Module'
6 6 .. automodule:: rhodecode.model
7 7 :members:
8 8
9 .. automodule:: rhodecode.model.comment
10 :members:
11
12 .. automodule:: rhodecode.model.notification
13 :members:
14
9 15 .. automodule:: rhodecode.model.permission
10 16 :members:
11 17
18 .. automodule:: rhodecode.model.repo_permission
19 :members:
20
12 21 .. automodule:: rhodecode.model.repo
13 22 :members:
14 23
24 .. automodule:: rhodecode.model.repos_group
25 :members:
26
15 27 .. automodule:: rhodecode.model.scm
16 28 :members:
17 29
18 30 .. automodule:: rhodecode.model.user
19 31 :members:
32
33 .. automodule:: rhodecode.model.users_group
34 :members: No newline at end of file
@@ -2,8 +2,8 b''
2 2
3 3 .. include:: ./../README.rst
4 4
5 Documentation
6 -------------
5 Users Guide
6 -----------
7 7
8 8 **Installation:**
9 9
@@ -23,7 +23,6 b' Documentation'
23 23 usage/enable_git
24 24 usage/statistics
25 25 usage/backup
26 usage/api_key_access
27 26
28 27 **Develop**
29 28
@@ -36,7 +35,7 b' Documentation'
36 35 **API**
37 36
38 37 .. toctree::
39 :maxdepth: 2
38 :maxdepth: 1
40 39
41 40 api/index
42 41
@@ -1,7 +1,7 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 rhodecode.model.notification
4 ~~~~~~~~~~~~~~
4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5 5
6 6 Model for notifications
7 7
1 NO CONTENT: file was removed
General Comments 0
You need to be logged in to leave comments. Login now