This took way to long, no more symlinks

sbenthall · Jul 16, 2024 · f8c0a8d · f8c0a8d
1 parent e3cf5dc
commit f8c0a8d
Show file tree

Hide file tree

Showing 25 changed files with 60 additions and 76 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -49,8 +49,9 @@ jobs:
       - name: Run Sphinx
         run: >
           sphinx-build
-          -M html Documentation HARK-docs
+          -M html . HARK-docs
           -T
+          -c Documentation
           -W
           -j 1
 

diff --git a/Documentation/_static/override-nbsphinx-gallery.css b/Documentation/_static/override-nbsphinx-gallery.css
diff --git a/Documentation/conf.py b/Documentation/conf.py
@@ -36,17 +36,28 @@
     "sphinx.ext.todo",
     # third-party extensions
     "nbsphinx",
-    "nbsphinx_link",
     "myst_parser",
     "sphinx_copybutton",
     "sphinx_design",
 ]
 
+
+include_patterns = [
+    "Documentation**",
+    "index.rst",
+]  # Makes sure that only the file we want documented get documented
+with open("example_notebooks//include_list", "r") as file:
+    include_patterns += file.readlines()
+include_patterns = [
+    i.replace("\n", "") for i in include_patterns
+]  # Adds example notebooks
+
 exclude_patterns = [
-    "_build",
-    "Thumbs.db",
-    ".DS_Store",
-    "NARK",
+    "Documentation/_build",
+    "Documentation/Thumbs.db",
+    "Documentation/.DS_Store",
+    "Documentation/NARK",
+    "Documentation/index_core.rst",  # Prevents sphinx from getting confused
 ]
 
 language = "en"
@@ -65,7 +76,7 @@
 
 # HTML writer configuration
 html_theme = "pydata_sphinx_theme"
-html_static_path = ["_static"]
+html_static_path = []
 html_css_files = [
     "override-nbsphinx-gallery.css",
 ]
@@ -156,4 +167,7 @@
 # nbsphinx configuration
 nbsphinx_execute = "never"  # notebooks are executed via ``nb_exec.py``
 
-suppress_warnings = ["config.cache"]
+suppress_warnings = [
+    "toc.excluded",  # Suppress warnings about documents not included in the toctree
+    "nbsphinx.notebooktitle",  # Suppress warnings about notebooks not having titles
+]
diff --git a/Documentation/example_notebooks/ConsPortfolioModel.nblink b/Documentation/example_notebooks/ConsPortfolioModel.nblink
diff --git a/Documentation/example_notebooks/GenIncProcessModel.nblink b/Documentation/example_notebooks/GenIncProcessModel.nblink
diff --git a/Documentation/example_notebooks/Gentle-Intro-To-HARK.nblink b/Documentation/example_notebooks/Gentle-Intro-To-HARK.nblink
diff --git a/Documentation/example_notebooks/HARK-struct-2.png b/Documentation/example_notebooks/HARK-struct-2.png
diff --git a/Documentation/example_notebooks/HARK-struct-3.png b/Documentation/example_notebooks/HARK-struct-3.png
diff --git a/Documentation/example_notebooks/HARK-struct-4.png b/Documentation/example_notebooks/HARK-struct-4.png
diff --git a/Documentation/example_notebooks/HowWeSolveIndShockConsumerType.nblink b/Documentation/example_notebooks/HowWeSolveIndShockConsumerType.nblink
diff --git a/Documentation/example_notebooks/Include_list b/Documentation/example_notebooks/Include_list
@@ -0,0 +1,13 @@
+examples/Gentle-Intro/Gentle-Intro-To-HARK.ipynb
+examples/ConsIndShockModel/PerfForesightConsumerType.ipynb
+examples/ConsIndShockModel/IndShockConsumerType.ipynb
+examples/ConsIndShockModel/KinkedRconsumerType.ipynb
+examples/ConsPortfolioModel/example_ConsPortfolioModel.ipynb
+examples/GenIncProcessModel/GenIncProcessModel.ipynb
+examples/LifecycleModel/LifecycleModel.ipynb
+examples/HowWeSolveIndShockConsumerType/HowWeSolveIndShockConsumerType.ipynb
+examples/Journeys/Journey-PhD.ipynb
+examples/ConsNewKeynesianModel/Transition_Matrix_Example.ipynb
+examples/ConsNewKeynesianModel/Jacobian_Example.ipynb
+examples/ConsNewKeynesianModel/KS-HARK-presentation.ipynb
+examples/ConsNewKeynesianModel/SSJ_example.ipynb
diff --git a/Documentation/example_notebooks/IndShockConsumerType.nblink b/Documentation/example_notebooks/IndShockConsumerType.nblink
diff --git a/Documentation/example_notebooks/Jacobian_Example.nblink b/Documentation/example_notebooks/Jacobian_Example.nblink
diff --git a/Documentation/example_notebooks/Journey-PhD.nblink b/Documentation/example_notebooks/Journey-PhD.nblink
diff --git a/Documentation/example_notebooks/KS-HARK-presentation.nblink b/Documentation/example_notebooks/KS-HARK-presentation.nblink
diff --git a/Documentation/example_notebooks/KinkedRconsumerType.nblink b/Documentation/example_notebooks/KinkedRconsumerType.nblink
diff --git a/Documentation/example_notebooks/LifecycleModel.nblink b/Documentation/example_notebooks/LifecycleModel.nblink
diff --git a/Documentation/example_notebooks/PerfForesightConsumerType.nblink b/Documentation/example_notebooks/PerfForesightConsumerType.nblink
diff --git a/Documentation/example_notebooks/SSJ_Example.nblink b/Documentation/example_notebooks/SSJ_Example.nblink
diff --git a/Documentation/example_notebooks/Transition_Matrix_Example.nblink b/Documentation/example_notebooks/Transition_Matrix_Example.nblink
diff --git a/Documentation/index.rst → Documentation/index_core.rst b/Documentation/index.rst → Documentation/index_core.rst
@@ -5,13 +5,13 @@ Econ-ARK documentation -- HARK
    :maxdepth: 1
    :hidden:
 
-   Guides <guides/index>
-   Overview & Examples <overview/index>
-   Reference <reference/index>
+   Guides <Documentation/guides/index>
+   Overview & Examples <Documentation/overview/index>
+   Reference <Documentation/reference/index>
 
 
 **Useful links**:
-:doc:`Install HARK <guides/installation>` |
+:doc:`Install HARK <Documentation/guides/installation>` |
 `Source Repository <https://github.com/Econ-ARK/HARK>`__ |
 `Issues & Ideas <https://github.com/Econ-ARK/HARK/issues>`__
 
@@ -44,7 +44,7 @@ you might want to look at the `DemARK
 
       +++
 
-      .. button-ref:: guides/quick_start
+      .. button-ref:: Documentation/guides/quick_start
          :ref-type: doc
          :color: info
          :click-parent:
@@ -63,7 +63,7 @@ you might want to look at the `DemARK
 
       +++
 
-      .. button-ref:: overview/index
+      .. button-ref:: Documentation/overview/index
          :ref-type: doc
          :color: info
          :click-parent:
@@ -83,7 +83,7 @@ you might want to look at the `DemARK
 
       +++
 
-      .. button-ref:: reference/index
+      .. button-ref:: Documentation/reference/index
          :ref-type: doc
          :color: info
          :click-parent:
@@ -105,7 +105,7 @@ you might want to look at the `DemARK
 
       +++
 
-      .. button-ref:: guides/contributing
+      .. button-ref:: Documentation/guides/contributing
          :ref-type: doc
          :color: info
          :click-parent:

diff --git a/Documentation/make.bat b/Documentation/make.bat
@@ -6,7 +6,7 @@ if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
 set BUILDDIR=_build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% -c . ..
 set I18NSPHINXOPTS=%SPHINXOPTS% .
 if NOT "%PAPER%" == "" (
 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%

diff --git a/Documentation/overview/index.rst b/Documentation/overview/index.rst
@@ -15,19 +15,19 @@ Overview
    :caption: Examples
    :maxdepth: 1
 
-   ../example_notebooks/Gentle-Intro-To-HARK
-   ../example_notebooks/PerfForesightConsumerType
-   ../example_notebooks/IndShockConsumerType
-   ../example_notebooks/KinkedRconsumerType
-   ../example_notebooks/ConsPortfolioModel
-   ../example_notebooks/GenIncProcessModel
-   ../example_notebooks/LifecycleModel
-   ../example_notebooks/HowWeSolveIndShockConsumerType
-   ../example_notebooks/Journey-PhD
-   ../example_notebooks/Transition_Matrix_Example
-   ../example_notebooks/Jacobian_Example
-   ../example_notebooks/KS-HARK-presentation
-   ../example_notebooks/SSJ_Example
+   ../../examples/Gentle-Intro/Gentle-Intro-To-HARK.ipynb
+   ../../examples/ConsIndShockModel/PerfForesightConsumerType.ipynb
+   ../../examples/ConsIndShockModel/IndShockConsumerType.ipynb
+   ../../examples/ConsIndShockModel/KinkedRconsumerType.ipynb
+   ../../examples/ConsPortfolioModel/example_ConsPortfolioModel.ipynb
+   ../../examples/GenIncProcessModel/GenIncProcessModel.ipynb
+   ../../examples/LifecycleModel/LifecycleModel.ipynb
+   ../../examples/HowWeSolveIndShockConsumerType/HowWeSolveIndShockConsumerType.ipynb
+   ../../examples/Journeys/Journey-PhD.ipynb
+   ../../examples/ConsNewKeynesianModel/Transition_Matrix_Example.ipynb
+   ../../examples/ConsNewKeynesianModel/Jacobian_Example.ipynb
+   ../../examples/ConsNewKeynesianModel/KS-HARK-presentation.ipynb
+   ../../examples/ConsNewKeynesianModel/SSJ_example.ipynb
 
 .. toctree::
    :hidden:

diff --git a/index.rst b/index.rst
@@ -0,0 +1 @@
+.. include:: Documentation/index_core.rst
diff --git a/requirements/doc.txt b/requirements/doc.txt
@@ -3,7 +3,7 @@
 ipython  # for the Pygments lexer
 myst-parser>=2
 nbsphinx>=0.8
-nbsphinx-link
+
 # theme requirements
 pydata-sphinx-theme
 sphinx>=6.1