Mercurial > kallithea
changeset 1839:9da24750f563 beta
docs update
| author | Marcin Kuzminski <marcin@python-works.com> |
|---|---|
| date | Fri, 06 Jan 2012 21:50:52 +0200 |
| parents | 2ef309c3175d |
| children | 87920d4f58c5 |
| files | README.rst docs/api/api.rst docs/api/index.rst docs/api/models.rst docs/index.rst docs/usage/api_key_access.rst rhodecode/model/notification.py |
| diffstat | 7 files changed, 30 insertions(+), 23 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Fri Jan 06 19:37:36 2012 +0200 +++ b/README.rst Fri Jan 06 21:50:52 2012 +0200 @@ -1,6 +1,6 @@ -================================================= -Welcome to RhodeCode (RhodiumCode) documentation! -================================================= +======================== +RhodeCode documentation! +======================== ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ with a built in push/pull server and full text search. @@ -102,7 +102,6 @@ - pull requests and web based merges - per line file history - SSH based authentication with server side key management -- Redmine and other bugtrackers integration - Commit based built in wiki system - More statistics and graph (global annotation + some more statistics) - Other advancements as development continues (or you can of course make
--- a/docs/api/api.rst Fri Jan 06 19:37:36 2012 +0200 +++ b/docs/api/api.rst Fri Jan 06 21:50:52 2012 +0200 @@ -10,6 +10,8 @@ with JSON protocol both ways. An url to send API request in RhodeCode is <your_server>/_admin/api +API ACCESS FOR WEB VIEWS +++++++++++++++++++++++++ API access can also be turned on for each view decorated with `@LoginRequired` decorator. To enable API access simple change standard login decorator into @@ -18,6 +20,9 @@ enabled on RSS/ATOM feed views. +API ACCESS +++++++++++ + All clients are required to send JSON-RPC spec JSON data:: {
--- a/docs/api/index.rst Fri Jan 06 19:37:36 2012 +0200 +++ b/docs/api/index.rst Fri Jan 06 21:50:52 2012 +0200 @@ -1,4 +1,4 @@ -.. _api: +.. _indexapi: API Reference =============
--- a/docs/api/models.rst Fri Jan 06 19:37:36 2012 +0200 +++ b/docs/api/models.rst Fri Jan 06 21:50:52 2012 +0200 @@ -6,14 +6,29 @@ .. automodule:: rhodecode.model :members: +.. automodule:: rhodecode.model.comment + :members: + +.. automodule:: rhodecode.model.notification + :members: + .. automodule:: rhodecode.model.permission :members: - + +.. automodule:: rhodecode.model.repo_permission + :members: + .. automodule:: rhodecode.model.repo :members: +.. automodule:: rhodecode.model.repos_group + :members: + .. automodule:: rhodecode.model.scm :members: - + .. automodule:: rhodecode.model.user :members: + +.. automodule:: rhodecode.model.users_group + :members: \ No newline at end of file
--- a/docs/index.rst Fri Jan 06 19:37:36 2012 +0200 +++ b/docs/index.rst Fri Jan 06 21:50:52 2012 +0200 @@ -2,8 +2,8 @@ .. include:: ./../README.rst -Documentation -------------- +Users Guide +----------- **Installation:** @@ -23,7 +23,6 @@ usage/enable_git usage/statistics usage/backup - usage/api_key_access **Develop** @@ -36,7 +35,7 @@ **API** .. toctree:: - :maxdepth: 2 + :maxdepth: 1 api/index
--- a/docs/usage/api_key_access.rst Fri Jan 06 19:37:36 2012 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,11 +0,0 @@ -.. _api_key_access: - -Access to RhodeCode via API KEY -=============================== - -Starting from version 1.2 rss/atom feeds and journal feeds -can be accessed via **api_key**. This unique key is automatically generated for -each user in RhodeCode application. Using this key it is possible to access -feeds without having to log in. When user changes his password a new API KEY -is generated for him automatically. You can check your API KEY in account -settings page. \ No newline at end of file