diff --git a/doc/source/index.rst b/doc/source/index.rst index 4c75a52..3b36b61 100644 --- 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 ================== diff --git a/doc/source/webapi/index.rst b/doc/source/webapi/index.rst new file mode 100644 index 0000000..5cd2b3e --- /dev/null +++ b/doc/source/webapi/index.rst @@ -0,0 +1,8 @@ +========= + Web API +========= + +.. toctree:: + :maxdepth: 2 + + v1 diff --git a/doc/source/webapi/v1.rst b/doc/source/webapi/v1.rst new file mode 100644 index 0000000..a048b29 --- /dev/null +++ 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 diff --git a/surveil/api/controllers/v1/hello.py b/surveil/api/controllers/v1/hello.py index 16841d4..0047c1f 100644 --- a/surveil/api/controllers/v1/hello.py +++ b/surveil/api/controllers/v1/hello.py @@ -6,4 +6,5 @@ class HelloController(rest.RestController): @pecan.expose() def get(self): + """Says hello.""" return "Hello World!"