add documentation for web API

jbweston · Jul 19, 2018 · 608b585 · 608b585
1 parent 89583ed
commit 608b585
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -7,3 +7,4 @@ API documentation
 
    reference/api.rst
    reference/vpn.rst
+   reference/web.rst
diff --git a/docs/source/reference/web.rst b/docs/source/reference/web.rst
@@ -0,0 +1,3 @@
+``nord.web``
+------------
+.. automodule:: nord.web
diff --git a/nord/web/__init__.py b/nord/web/__init__.py
@@ -16,12 +16,8 @@
 # along with this program.  if not, see <http://www.gnu.org/licenses/>.
 """Serve nord as a web app.
 
-To use this package as a library, simply instantiate an instance of the
-app with `init_app`.
-
 The API can be accessed by opening a websocket connection to '/api'.
 
-
 Requests
 ========
 The API accepts 2 types of request.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@ API documentation

		reference/api.rst
		reference/vpn.rst
		reference/web.rst