Change plotly rendering to allow for correct figure rendering on GitHub

OpenSourceEconomics · Jun 19, 2024 · 61ab2f2 · 61ab2f2
1 parent cdc0170
commit 61ab2f2
Show file tree

Hide file tree

Showing 2 changed files with 174 additions and 4,520 deletions.
diff --git a/explanations/README.md b/explanations/README.md
@@ -1,9 +1,11 @@
 # Explanations of internal `lcm` concepts
 
 > [!NOTE]
-> The following explanations are designed for `lcm` developers and not users.
+> 1. The following explanations are designed for `lcm` developers and not users.
+> 1. Figures are only rendered correctly on nbviewer, not on GitHub. Please use the
+>    links below to view the correctly rendered notebooks.
 
-| Module name                                                     | Description                                                            |
-| --------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| [`dispatchers.py`](./dispatchers.ipynb)                         | Explanations of `spacemap`, `productmap`, and `vmap_1d` functions      |
-| [`function_representation.py`](./function_representation.ipynb) | Explanations of what the function representation does and how it works |
+| Module name                                                                                                                              | Description                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| [`dispatchers.py`](https://nbviewer.org/github/OpenSourceEconomics/lcm/blob/main/explanations/dispatchers.ipynb)                         | Explanations of `spacemap`, `productmap`, and `vmap_1d` functions      |
+| [`function_representation.py`](https://nbviewer.org/github/OpenSourceEconomics/lcm/blob/main/explanations/function_representation.ipynb) | Explanations of what the function representation does and how it works |