Running doctests using doctest-plus

pybamm/expression_tree/operations/latexify.py

@@ -38,16 +38,16 @@ class Latexify:
     >>> model = pybamm.lithium_ion.SPM()
 
     This will returns all model equations in png
-    >>> model.latexify("equations.png")
+    >>> model.latexify("equations.png") # doctest: +SKIP
 
     This will return all the model equations in latex
-    >>> model.latexify()
+    >>> model.latexify() # doctest: +SKIP
 
     This will return the list of all the model equations
-    >>> model.latexify(newline=False)
+    >>> model.latexify(newline=False) # doctest: +SKIP
 
     This will return first five model equations
-    >>> model.latexify(newline=False)[1:5]
+    >>> model.latexify(newline=False)[1:5] # doctest: +SKIP
     """
 
     def __init__(self, model, filename: str | None = None, newline: bool = True):

pybamm/models/base_model.py

@@ -1345,16 +1345,16 @@ def latexify(self, filename=None, newline=True, output_variables=None):
         >>> model = pybamm.lithium_ion.SPM()
 
         This will returns all model equations in png
-        >>> model.latexify("equations.png")
+        >>> model.latexify("equations.png") # doctest: +SKIP
 
         This will return all the model equations in latex
-        >>> model.latexify()
+        >>> model.latexify() # doctest: +SKIP
 
         This will return the list of all the model equations
-        >>> model.latexify(newline=False)
+        >>> model.latexify(newline=False) # doctest: +SKIP
 
         This will return first five model equations
-        >>> model.latexify(newline=False)[1:5]
+        >>> model.latexify(newline=False)[1:5] # doctest: +SKIP
         """
         from pybamm.expression_tree.operations.latexify import Latexify
 

pybamm/models/full_battery_models/lithium_metal/dfn.py

@@ -2,7 +2,7 @@
 # Doyle-Fuller-Newman (DFN) Model
 #
 import pybamm
-from ..lithium_ion.dfn import DFN as LithiumIonDFN
+from pybamm.models.full_battery_models.lithium_ion.dfn import DFN as LithiumIonDFN
 
 
 class DFN(LithiumIonDFN):

pybamm/parameters/parameter_sets.py

@@ -17,6 +17,7 @@ class ParameterSets(Mapping):
 
     .. doctest::
 
+        >>> import pybamm
         >>> list(pybamm.parameter_sets)
         ['Ai2020', 'Chen2020', ...]
 

pyproject.toml

@@ -103,6 +103,8 @@ dev = [
     "nox",
     # For coverage
     "pytest-cov",
+    # For doctest
+    "pytest-doctestplus",
     # For test parameterization
     "parameterized>=0.9",
     # For testing Jupyter notebooks

run-tests.py

@@ -86,6 +86,15 @@ def run_doc_tests():
             ],
             check=True,
         )
+        print("Checking for doctests.")
+        subprocess.run(
+            [
+                "pytest",
+                "--doctest-plus",
+                "pybamm",
+            ],
+            check=True,
+        )
     except subprocess.CalledProcessError as e:
         print(f"FAILED with exit code {e.returncode}")
         sys.exit(e.returncode)