Merge pull request #7 from adamboche/doctest

Use doctest
adamboche · Jun 8, 2019 · f501b3b · f501b3b
2 parents 0326c34 + 5d7d630
commit f501b3b
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 16 deletions.
diff --git a/dev-requirements.in b/dev-requirements.in
@@ -13,3 +13,4 @@ readme-renderer
 pygments
 isort
 mypy
+pytest-sphinx
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -35,6 +35,7 @@ py==1.8.0                 # via pytest, tox
 pygments==2.4.2
 pylint==2.3.1
 pyparsing==2.4.0          # via packaging
+pytest-sphinx==0.2.2
 pytest==4.6.2
 pyyaml==5.1.1             # via watchdog
 readme-renderer==24.0

diff --git a/docs/conf.py b/docs/conf.py
@@ -53,3 +53,4 @@
 napoleon_use_param = True
 
 autoapi_dirs = ["../src/marshmallow_union"]
+
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,24 +2,35 @@
 Usage
 =====
 
-To use marshmallow-union in a project::
+To use marshmallow-union in a project
 
-	import marshmallow_union
+.. testcode::
 
+    import marshmallow
+    import marshmallow_union
 
-	class PersonSchema(marshmallow.Schema):
-		name = marshmallow.fields.String()
-		number_or_numbers = marshmallow_union.Union(
-			[
-				marshmallow.fields.List(marshmallow.fields.Integer()),
-				marshmallow.fields.Integer(),
-			],
-			reverse_serialize_candidates=True,
-		)
 
+    class PersonSchema(marshmallow.Schema):
+        name = marshmallow.fields.String()
+        number_or_numbers = marshmallow_union.Union(
+            [
+                marshmallow.fields.List(marshmallow.fields.Integer()),
+                marshmallow.fields.Integer(),
+            ],
+        	reverse_serialize_candidates=True,
+        )
 
-	data = {"name": "Alice", "number_or_numbers": 25}
-	schema = PersonSchema()
-	
-	loaded = schema.load(data)
-	dumped = schema.dump(data)
+
+
+    input_data = {"name": "Alice", "number_or_numbers": 25}
+    schema = PersonSchema()
+
+    loaded = schema.load(input_data)
+    dumped = schema.dump(loaded)
+
+    assert dumped == input_data
+
+
+
+
+.. testoutput::
diff --git a/tox.ini b/tox.ini
@@ -67,6 +67,7 @@ deps =
      -r{toxinidir}/docs/requirements.txt
 commands =
     sphinx-apidoc -o docs/reference -f src
+    sphinx-build {posargs:-E} -b doctest docs dist/docs
     sphinx-build {posargs:-E} -b html docs dist/docs
     sphinx-build -b linkcheck docs dist/docs