Add a submodule of DemARK and include a notebook in the doc build for it

econ-ark · Aug 8, 2019 · d9136e9 · d9136e9
1 parent 1716665
commit d9136e9
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "Documentation/submodules/DemARK"]
+	path = Documentation/submodules/DemARK
+	url = https://github.com/econ-ark/DemARK
diff --git a/Documentation/index.rst b/Documentation/index.rst
@@ -12,7 +12,7 @@ Welcome to HARK's documentation!
    :caption: Notebooks
 
    notebooks/Gentle-Intro-To-HARK
-   notebooks/DCT-Copula-Illustration
+   submodules/DemARK/notebooks/KinkedRconsumerType
 
 .. toctree::
    :maxdepth: 2

diff --git a/Documentation/notebooks/README.rst b/Documentation/notebooks/README.rst
@@ -0,0 +1,12 @@
+Adding a notebook
+-----------------
+
+You can add a notebook here to be included in the docs by creating a symlink to an existing notebook.
+This lets you keep them in the original place,
+but also include them in your docs here.
+
+This would be done with a command like this::
+
+    ln -s ../../Examples/Gentle-Intro-To-HARK.ipynb .
+
+That would create a symlink here to the ``Examples/Gentle-Intro-To-HARK.ipynb`` notebook.
diff --git a/Documentation/submodules/DemARK b/Documentation/submodules/DemARK