kallithea Changeset - 9da24750f563

Changeset - 9da24750f563

Parent rev.

Child rev.

[Not reviewed]

beta

1 6 0

Marcin Kuzminski - 14 years ago 2012-01-06 20:50:52
marcin@python-works.com

docs update

7 files changed with 30 insertions and 23 deletions:

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

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

 =================================================
 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

docs/api/api.rst

➞

Show inline comments

@@ @@ -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
 <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 @@ 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::
+    {

docs/api/index.rst

➞

Show inline comments

-.. _api:
+.. _indexapi:
 API Reference
 =============

docs/api/models.rst

➞

Show inline comments

@@ @@ -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 @@

docs/index.rst

➞

Show inline comments

@@ @@ -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

docs/usage/api_key_access.rst

➞

Show inline comments

deleted file

rhodecode/model/notification.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 """
     rhodecode.model.notification
     ~~~~~~~~~~~~~~
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     Model for notifications

0 comments (0 inline, 0 general)