address comments and related issues

Author: OriolAbril

.github/workflows/rtd-link-preview.yml

@@ -13,4 +13,4 @@ jobs:
     steps:
       - uses: readthedocs/actions/preview@v1
         with:
-          project-slug: "pymc"
+          project-slug: "causalpy"

.gitignore

@@ -7,6 +7,8 @@ _build
 build/
 dist/
 docs/_build/
+docs/build/
+docs/jupyter_execute/
 *.vscode
 .coverage
 *.jupyterlab-workspace

README.md

@@ -34,7 +34,7 @@ pip install git+https://github.com/pymc-labs/CausalPy.git
 
 ```python
 import causalpy as cp
-
+import matplotlib.pyplot as plt
 
 # Import and process data
 df = (
@@ -57,6 +57,8 @@ fig, ax = result.plot();
 
 # Get a results summary
 result.summary()
+
+plt.show()
 ```
 
 ## Roadmap

docs/source/conf.py

@@ -74,8 +74,15 @@
 
 # -- intersphinx config -------------------------------------------------------
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3", None),
+    "examples": ("https://www.pymc.io/projects/examples/en/latest/", None),
+    "mpl": ("https://matplotlib.org/stable", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
     "pymc": ("https://www.pymc.io/projects/docs/en/stable/", None),
+    "python": ("https://docs.python.org/3", None),
+    "scikit-learn": ("https://scikit-learn.org/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
 }
 
 # MyST options for working with markdown files.

docs/source/index.rst

@@ -12,12 +12,18 @@ A Python package focussing on causal inference for quasi-experiments. The packag
 Installation
 ------------
 
-To get the latest release:
+To get the latest release you can use pip:
 
 .. code-block:: sh
 
    pip install CausalPy
 
+or conda:
+
+.. code-block:: sh
+
+   conda install causalpy -c conda-forge
+
 Alternatively, if you want the very latest version of the package you can install from GitHub:
 
 .. code-block:: sh
@@ -31,6 +37,7 @@ Quickstart
 .. code-block:: python
 
    import causalpy as cp
+   import matplotlib.pyplot as plt
 
 
    # Import and process data
@@ -55,6 +62,8 @@ Quickstart
    # Get a results summary
    result.summary()
 
+   plt.show()
+
 
 Videos
 ------

pyproject.toml

@@ -54,7 +54,7 @@ docs = [
     "ipykernel",
     "daft",
     "linkify-it-py",
-    "myst-nb<=1.0.0",
+    "myst-nb!=1.1.0",
     "pathlib",
     "sphinx",
     "sphinx-autodoc-typehints",