Update tests

See #1

Pipfile

@@ -5,9 +5,12 @@ name = "pypi"
 
 [packages]
 sphinx = "*"
+faker = "*"
 
 [dev-packages]
 jupyter = "*"
+pytest = "*"
+pytest-cov = "*"
 pyyaml = "*"
 semver = {ref = "2.13.0", git = "https://github.com/python-semver/python-semver.git"}
 wheel = "*"

sphinxjsondomain.py

@@ -354,7 +354,7 @@ def generate_examples(self, docname):
         """
         Generate example snippets after the document has been processed.
 
-        :param str docname: documentat that is being processed.  This is
+        :param str docname: document that is being processed.  This is
             used to report warnings.
 
         This is called from within :meth:`.process_doc` after our superclass
@@ -508,6 +508,7 @@ def generate_sample_data(self, all_objects, fake_factory):
 
 
 def normalize_object_name(obj_name):
+    """Adjust object names to conform with our preferences."""
     return re.sub(r'\s+', '-', obj_name).strip('-').lower()
 
 

test_sphinxjsondomain.py

@@ -0,0 +1,5 @@
+import sphinxjsondomain
+
+def test_normalize_object_name():
+    """Test object name normalization."""
+    assert True