Add Sphinx documentation for the unit tests

Just docstrings on the classes themselves, not the individual tests.

Author: bootc

docs/conf.py

@@ -21,6 +21,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.realpath('../'))
+sys.path.insert(0, os.path.realpath('../tests/'))
 
 # -- General configuration ------------------------------------------------
 

docs/index.rst

@@ -13,6 +13,7 @@ Contents:
 
    pypuppetdbquery
    examples
+   tests
 
 Indices and tables
 ==================

docs/tests.rst

@@ -0,0 +1,22 @@
+Test Suite
+==========
+
+.. automodule:: test_frontend
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: test_integration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: test_lexer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: test_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:

tests/test_frontend.py

@@ -23,20 +23,22 @@
 
 class TestFrontend(unittest.TestCase):
     """
-    Test suite for `pypuppetdbquery.parse`.
+    Test cases targetting :mod:`pypuppetdbquery`, and particularly
+    :func:`pypuppetdbquery.parse`.
     """
     def _parse(self, s, **kwargs):
-        return parse(s, parser_opts={
-            'lex_options': {
+        return parse(
+            s,
+            lex_options={
                 'debug': False,
                 'optimize': False,
             },
-            'yacc_options': {
+            yacc_options={
                 'debug': False,
                 'optimize': False,
                 'write_tables': False,
             },
-        }, **kwargs)
+            **kwargs)
 
     def test_empty_queries(self):
         out = self._parse('')

tests/test_integration.py

@@ -23,8 +23,10 @@
 
 class TestIntegration(unittest.TestCase):
     """
-    Test suite for the combination of `pypuppetdb.lexer.Lexer`,
-    `pypuppetdbquery.parser.Parser`, and `pypuppetdb.evaluator.Evaluator`.
+    Test cases for the integrated combination of
+    :class:`pypuppetdbquery.lexer.Lexer`,
+    :class:`pypuppetdbquery.parser.Parser`, and
+    :class:`pypuppetdbquery.evaluator.Evaluator`.
     """
     def setUp(self):
         self.parser = Parser(

tests/test_lexer.py

@@ -22,7 +22,7 @@
 
 class TestLexer(unittest.TestCase):
     """
-    Test suite for `pypuppetdbquery.lexer.Lexer`.
+    Test cases for :class:`pypuppetdbquery.lexer.Lexer`.
     """
     def setUp(self):
         self.lexer = Lexer(

tests/test_parser.py

@@ -23,7 +23,7 @@
 
 class TestParster(unittest.TestCase):
     """
-    Test suite for `pypuppetdbquery.parser.Parser`.
+    Test cases for :class:`pypuppetdbquery.parser.Parser`.
     """
     def setUp(self):
         self.parser = Parser(