Merge pull request #207 from pymc-labs/update-docstring

Update docstring to explain `sample_kwargs` + add intersphinx

Author: drbenvincent

causalpy/pymc_models.py

@@ -9,10 +9,14 @@
 
 class ModelBuilder(pm.Model):
     """
-    This is a wrapper around pm.Model to give scikit-learn like API
+    This is a wrapper around pm.Model to give scikit-learn like API.
     """
 
     def __init__(self, sample_kwargs: Optional[Dict[str, Any]] = None):
+        """
+        :param sample_kwargs: A dictionary of kwargs that get unpacked and passed to the
+            :func:`pymc.sample` function. Defaults to an empty dictionary.
+        """
         super().__init__()
         self.idata = None
         self.sample_kwargs = sample_kwargs if sample_kwargs is not None else {}

docs/source/conf.py

@@ -46,18 +46,25 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    "sphinx.ext.mathjax",
+    "myst_parser",
+    "nbsphinx",
     "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.mathjax",
     "sphinx_autodoc_typehints",
-    "nbsphinx",
-    "myst_parser",
 ]
 
 source_suffix = [".rst", ".md"]
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 master_doc = "index"
 
+# -- intersphinx config -------------------------------------------------------
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "pymc": ("https://www.pymc.io/projects/docs/en/stable/", None),
+}
+
 # -- nbsphinx config ----------------------------------------------------------
 # Opt out of executing the notebooks remotely. This will save time in the remote build
 # process on readthedocs. The notebooks in /docs/notebooks will be parsed/converted,

pyproject.toml

@@ -61,6 +61,7 @@ docs = ["ipykernel",
     "pathlib",
     "sphinx",
     "sphinx-autodoc-typehints",
+    "sphinx_autodoc_defaultargs",
     "sphinx-design",
     "sphinx-rtd-theme",
     "statsmodels",