From f34846e62c3a7a358a4a9f62defb648aa5558e1e Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Thu, 31 May 2018 13:05:18 -0400 Subject: [PATCH 1/2] Added API docs for dbmonitor --- docs/source/dbmonitor.rst | 7 +++++++ docs/source/index.rst | 3 ++- 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/source/dbmonitor.rst diff --git a/docs/source/dbmonitor.rst b/docs/source/dbmonitor.rst new file mode 100644 index 000000000..9d7024c2a --- /dev/null +++ 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 index d1890cc2a..000931490 100644 --- 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 ================== From 711b9fc472b36699954c7a6545b7000d4b81851f Mon Sep 17 00:00:00 2001 From: Matthew Bourque Date: Thu, 31 May 2018 13:10:09 -0400 Subject: [PATCH 2/2] Added sphinx docs for test_dbmonitor and test_utils. Also minor formatting changes in docstring for test_permissions. --- docs/source/tests.rst | 6 ++++++ jwql/tests/test_dbmonitor.py | 2 +- jwql/tests/test_permissions.py | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/tests.rst b/docs/source/tests.rst index 175c9299b..682eca9e1 100644 --- 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 index 516b0d118..0f8ba352b 100755 --- 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 index 132e80202..bcb455c6e 100755 --- 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 -------