diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -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 @@ Incoming / Plans - 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 diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -10,6 +10,8 @@ There's a single schema for calling all with JSON protocol both ways. An url to send API request in RhodeCode is /_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 @@ by adding a GET parameter to url `?api_k enabled on RSS/ATOM feed views. +API ACCESS +++++++++++ + All clients are required to send JSON-RPC spec JSON data:: { diff --git a/docs/api/index.rst b/docs/api/index.rst --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,4 +1,4 @@ -.. _api: +.. _indexapi: API Reference ============= diff --git a/docs/api/models.rst b/docs/api/models.rst --- a/docs/api/models.rst +++ b/docs/api/models.rst @@ -6,14 +6,29 @@ The :mod:`models` Module .. 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 diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -2,8 +2,8 @@ .. include:: ./../README.rst -Documentation -------------- +Users Guide +----------- **Installation:** @@ -23,7 +23,6 @@ Documentation usage/enable_git usage/statistics usage/backup - usage/api_key_access **Develop** @@ -36,7 +35,7 @@ Documentation **API** .. toctree:: - :maxdepth: 2 + :maxdepth: 1 api/index diff --git a/docs/usage/api_key_access.rst b/docs/usage/api_key_access.rst deleted file mode 100644 --- a/docs/usage/api_key_access.rst +++ /dev/null @@ -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 diff --git a/rhodecode/model/notification.py b/rhodecode/model/notification.py --- a/rhodecode/model/notification.py +++ b/rhodecode/model/notification.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """ rhodecode.model.notification - ~~~~~~~~~~~~~~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Model for notifications