Merge pull request #83 from bourque/db-monitor-docs

sphinx docs for dbmonitor
spacetelescope · Jun 2, 2018 · f1f17dd · f1f17dd
2 parents 9a3edea + 711b9fc
commit f1f17dd
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 3 deletions.
diff --git a/docs/source/dbmonitor.rst b/docs/source/dbmonitor.rst
@@ -0,0 +1,7 @@
+*********
+dbmonitor
+*********
+
+.. automodule:: jwql.dbmonitor.dbmonitor
+    :members:
+    :undoc-members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,11 +19,12 @@ API documentation
    :maxdepth: 1
    :caption: Contents:
 
+   dbmonitor.rst
    permissions.rst
    preview_image.rst
    utils.rst
    tests.rst
-	     
+
 
 Indices and tables
 ==================

diff --git a/docs/source/tests.rst b/docs/source/tests.rst
@@ -2,5 +2,11 @@
 tests
 *****
 
+.. automodule:: jwql.tests.test_dbmonitor
+    :members:
+
 .. automodule:: jwql.tests.test_permissions
     :members:
+
+.. automodule:: jwql.tests.test_utils
+    :members:
diff --git a/jwql/tests/test_dbmonitor.py b/jwql/tests/test_dbmonitor.py
@@ -1,6 +1,6 @@
 #! /usr/bin/env python
 
-"""Tests for the dbmonitor module.
+"""Tests for the ``dbmonitor`` module.
 
 Authors
 -------

diff --git a/jwql/tests/test_permissions.py b/jwql/tests/test_permissions.py
@@ -1,6 +1,6 @@
 #! /usr/bin/env python
 
-"""Tests for the permissions module.
+"""Tests for the ``permissions`` module.
 
 Authors
 -------