Swap to pytest-doctestplus

conftest.py

@@ -1,33 +1,33 @@
-# Copyright (c) 2024, Glotzer Group
-# This file is from the parsnip project, released under the BSD 3-Clause License.
+# # Copyright (c) 2024, Glotzer Group
+# # This file is from the parsnip project, released under the BSD 3-Clause License.
 
-import doctest
+# import doctest
 
-import pytest
-from sybil import Sybil
-from sybil.parsers.doctest import DocTestParser
-from sybil.parsers.rest import DocTestDirectiveParser
+# import pytest
+# from sybil import Sybil
+# from sybil.parsers.doctest import DocTestParser
+# from sybil.parsers.rest import DocTestDirectiveParser
 
-DOCTEST_OPTIONFLAGS = (
-    doctest.NORMALIZE_WHITESPACE | doctest.IGNORE_EXCEPTION_DETAIL | doctest.ELLIPSIS
-)
+# DOCTEST_OPTIONFLAGS = (
+#     doctest.NORMALIZE_WHITESPACE | doctest.IGNORE_EXCEPTION_DETAIL | doctest.ELLIPSIS
+# )
 
-@pytest.fixture(scope="module")
-def changedir():
-    import os
-    cwd = os.getcwd()
-    try:
-        os.chdir("doc/source")
-    finally:
-        os.chdir(cwd)
+# @pytest.fixture(scope="module")
+# def changedir():
+#     import os
+#     cwd = os.getcwd()
+#     try:
+#         os.chdir("doc/source")
+#     finally:
+#         os.chdir(cwd)
 
-pytest_collect_file = Sybil(
-    parsers=[
-         DocTestParser(optionflags=DOCTEST_OPTIONFLAGS),
-         # DocTestDirectiveParser(optionflags=DOCTEST_OPTIONFLAGS)
-        # DocTestParser(optionflags=doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS)
-    ],
-    pattern="*.rst",
-    path="doc/source",
-    fixtures=['changedir']
-).pytest()
+# pytest_collect_file = Sybil(
+#     parsers=[
+#          DocTestParser(optionflags=DOCTEST_OPTIONFLAGS),
+#          # DocTestDirectiveParser(optionflags=DOCTEST_OPTIONFLAGS)
+#         # DocTestParser(optionflags=doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS)
+#     ],
+#     pattern="*.rst",
+#     path="doc/source",
+#     fixtures=['changedir']
+# ).pytest()

doc/source/conf.py

@@ -26,7 +26,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx_copybutton",
-    # "pytest_doctestplus.sphinx.doctestplus",
+    "pytest_doctestplus.sphinx.doctestplus",
     "autodocsumm",
     "notfound.extension"
 ]

doc/source/quickstart.rst

@@ -16,17 +16,15 @@ Now, let's read extract the key-value pairs from our cif file. This subset of da
 usually contains information to reconstruct the system's unit cell, and provides
 information regarding the origin of the data.
 
-.. invisible-code-block:
-
-   from parsnip import CifFile
-   filename = "example_file.cif"
-   cif = CifFile(filename)
+.. testsetup::
 
+    >>> import os
+    >>> os.chdir("doc/source")
 
 .. doctest::
 
     >>> from parsnip import CifFile
-    >>> filename = "doc/source/example_file.cif" # TODO: fix filename
+    >>> filename = "example_file.cif"
     >>> cif = CifFile(filename)
 
     >>> cif.pairs
@@ -129,7 +127,7 @@ convenient.
         array([['0.0000000000', '0.0000000000', '0.0000000000']], dtype='<U12')
 
     >>> xyz.astype(float)
-        array([[0.0, 0.0, 0.0]], dtype=np.float64)
+        array([[0., 0., 0.]])
 
 
 

pyproject.toml

@@ -38,10 +38,10 @@ optional-dependencies = {tests = { file = ["tests/requirements.in"] }, doc = { f
 # testpaths = ["doc", "tests", "parsnip"]
 testpaths = ["doc"]
 console_output_style = "progress"
-# addopts = ["--doctest-plus", "--doctest-glob='*.rst'"]
-addopts = ["-p no:doctest"]
-# doctest_rst = true
-# doctest_optionflags = ["NORMALIZE_WHITESPACE", "ELLIPSIS", "FLOAT_CMP", "REPORT_CDIFF"]
+addopts = ["--doctest-plus", "--doctest-glob='*.rst'"]
+# addopts = ["-p no:doctest"]
+doctest_rst = true
+doctest_optionflags = ["NORMALIZE_WHITESPACE", "ELLIPSIS", "FLOAT_CMP", "REPORT_CDIFF"]
 # doctest_optionflags = ["NORMALIZE_WHITESPACE", "ELLIPSIS"]
 
 [tool.ruff]