Merge pull request #3600 from pybamm-team/doctest-conf

configure doctest so we don't have to import pybamm

docs/conf.py

@@ -76,6 +76,7 @@
 
 doctest_global_setup = """
 from docs import *
+import pybamm
 """
 
 # Add any paths that contain templates here, relative to this directory.

pybamm/citations.py

@@ -21,7 +21,6 @@ class Citations:
 
     Examples
     --------
-    >>> import pybamm
     >>> pybamm.citations.register("Sulzer2021")
     >>> pybamm.citations.register("@misc{Newton1687, title={Mathematical...}}")
     >>> pybamm.print_citations("citations.txt")

pybamm/expression_tree/symbol.py

@@ -423,7 +423,12 @@ def set_id(self):
         need to hash once.
         """
         self._id = hash(
-            (self.__class__, self.name, *tuple([child.id for child in self.children]), *tuple([(k, tuple(v)) for k, v in self.domains.items() if v != []]))
+            (
+                self.__class__,
+                self.name,
+                *tuple([child.id for child in self.children]),
+                *tuple([(k, tuple(v)) for k, v in self.domains.items() if v != []]),
+            )
         )
 
     @property
@@ -532,7 +537,6 @@ def pre_order(self):
         Examples
         --------
 
-        >>> import pybamm
         >>> a = pybamm.Symbol('a')
         >>> b = pybamm.Symbol('b')
         >>> for node in (a*b).pre_order():

pybamm/models/full_battery_models/equivalent_circuit/thevenin.py

@@ -52,7 +52,6 @@ class Thevenin(pybamm.BaseModel):
 
     Examples
     --------
-    >>> import pybamm
     >>> model = pybamm.equivalent_circuit.Thevenin()
     >>> model.name
     'Thevenin Equivalent Circuit Model'

pybamm/models/full_battery_models/lithium_ion/dfn.py

@@ -13,7 +13,6 @@ class DFN(BaseModel):
 
     Examples
     --------
-    >>> import pybamm
     >>> model = pybamm.lithium_ion.DFN()
     >>> model.name
     'Doyle-Fuller-Newman model'

pybamm/models/full_battery_models/lithium_ion/mpm.py

@@ -13,7 +13,6 @@ class MPM(SPM):
 
     Examples
     --------
-    >>> import pybamm
     >>> model = pybamm.lithium_ion.MPM()
     >>> model.name
     'Many-Particle Model'

pybamm/models/full_battery_models/lithium_ion/spm.py

@@ -13,7 +13,6 @@ class SPM(BaseModel):
 
     Examples
     --------
-    >>> import pybamm
     >>> model = pybamm.lithium_ion.SPM()
     >>> model.name
     'Single Particle Model'

pybamm/models/full_battery_models/lithium_ion/spme.py

@@ -14,7 +14,6 @@ class SPMe(SPM):
 
     Examples
     --------
-    >>> import pybamm
     >>> model = pybamm.lithium_ion.SPMe()
     >>> model.name
     'Single Particle Model with electrolyte'

pybamm/parameters/parameter_sets.py

@@ -16,15 +16,13 @@ class ParameterSets(Mapping):
 
     .. doctest::
 
-        >>> import pybamm
         >>> list(pybamm.parameter_sets)
         ['Ai2020', 'Chen2020', ...]
 
     Get the docstring for a parameter set:
 
     .. doctest::
 
-        >>> import pybamm
         >>> print(pybamm.parameter_sets.get_docstring("Ai2020"))
         <BLANKLINE>
         Parameters for the Enertech cell (Ai2020), from the papers :footcite:t:`Ai2019`,
@@ -44,7 +42,7 @@ def __init__(self):
     @staticmethod
     def get_entries(group_name):
         # Wrapper for the importlib version logic
-        if sys.version_info < (3, 10): # pragma: no cover
+        if sys.version_info < (3, 10):  # pragma: no cover
             return importlib.metadata.entry_points()[group_name]
         else:
             return importlib.metadata.entry_points(group=group_name)

pybamm/parameters/parameter_values.py

@@ -24,7 +24,6 @@ class ParameterValues:
 
     Examples
     --------
-    >>> import pybamm
     >>> values = {"some parameter": 1, "another parameter": 2}
     >>> param = pybamm.ParameterValues(values)
     >>> param["some parameter"]