Merge "Added dummy API documentation"

2014-08-15 15:27:01 +00:00 · 2014-08-15 15:27:01 +00:00 · 1258092a98
commit 1258092a98
parent 81193cc055 f80b5f2050
4 changed files with 22 additions and 1 deletions
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -2,12 +2,13 @@
 Welcome to Surveil's documentation!
 ===================================

-Contents:
+Table of Contents:

 .. toctree::
   :maxdepth: 2

   readme
+   webapi/index

 Indices and tables
 ==================
--- a/doc/source/webapi/index.rst
+++ b/doc/source/webapi/index.rst
@ -0,0 +1,8 @@
+=========
+ Web API
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   v1
--- a/doc/source/webapi/v1.rst
+++ b/doc/source/webapi/v1.rst
@ -0,0 +1,11 @@
+.. docbookrestapi
+
+============
+ V1 Web API
+============
+
+Hello
+=====
+
+.. rest-controller:: surveil.api.controllers.v1.hello:HelloController
+   :webprefix: /v1/hello
--- a/surveil/api/controllers/v1/hello.py
+++ b/surveil/api/controllers/v1/hello.py
@ -20,4 +20,5 @@ class HelloController(rest.RestController):

    @pecan.expose()
    def get(self):
+        """Says hello."""
        return "Hello World!"