diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..b2bc1c87d --- /dev/null +++ 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 index 19c2a4b14..a5c0650f1 100644 --- 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 new file mode 100644 index 000000000..b41375a6e --- /dev/null +++ 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 new file mode 160000 index 000000000..ad40b284e --- /dev/null +++ b/Documentation/submodules/DemARK @@ -0,0 +1 @@ +Subproject commit ad40b284e3b9320daac0e4b5d75a3335072b4f12