Edit documentation conf

Author: amageh

docs/rtd_environment.yml

@@ -7,7 +7,8 @@ dependencies:
   - python=3.9
   - pip
   - ipython
-  - nbsphinx
+  - jupyter
+  - myst-nb
   - numpydoc
   - sphinx
   - sphinx-autobuild

docs/source/background/interface_plots.ipynb

@@ -4,7 +4,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# The Interface Functions and Solution Container\n",
+    "# The Interface Functions and Solution Container"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
     "\n",
     "In this tutorial, we demonstrate how to use the interface functions of the `dcegm` package to visualize the solved model and explain the structure of the solution container, which is the output of the `solve` function.\n",
     "\n",

docs/source/background/specify_exogenous_processes.md

@@ -1,5 +1,6 @@
 # Specifying Exogenous Processes in the DCEGM Module
 
+
 ## Overview
 
 Exogenous processes in the ```dcegm``` module define how state variables evolve over time based on transition probabilities. These transition probabilities must be properly specified to ensure consistency with the model structure. This document outlines how to define exogenous processes and specify them within the model's ```options``` dictionary.

docs/source/conf.py

@@ -33,6 +33,9 @@
     "sphinx.ext.doctest",
     "sphinx.ext.extlinks",  # link to websites using abbreviations
     "sphinx.ext.napoleon",
+    "myst_nb",  # Already present per rtd_environment.yml
+    "sphinx.ext.mathjax",  # For math in notebooks
+    "sphinx.ext.githubpages",  # For gh-pages'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -48,8 +51,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ["_build", "**.ipynb_checkpoints"]
 
+# Ensure Jupyter notebooks are parsed
+nbsphinx_allow_errors = True  # Optional: continue build even if code cells fail
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -63,6 +68,9 @@
     "top_of_page_button": "edit",
     "navigation_with_keys": True,
     "sidebar_hide_name": False,
+    "source_repository": "https://github.com/OpenSourceEconomics/dc-egm",
+    "source_branch": "main",
+    "source_directory": "docs/source",
     "footer_icons": [
         {
             "name": "GitHub",
@@ -75,7 +83,7 @@
             "class": "",
         },
     ],
-    "announcement": "This documentation is under construction.",
+    #"announcement": "This documentation is under construction.",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -92,3 +100,7 @@
 
 # Path for sphinx-autoapi
 autoapi_dirs = ["../../src"]
+
+source_suffix = [".rst", ".ipynb", ".md"]
+
+# note: do not add .ipynb when nbspinx is enabled, otherwise you get the "missing title" error

docs/source/development/team.rst

@@ -5,19 +5,43 @@ Team
 =======
 
 
-+---------------------------------------------------------------+-------------------------------------------------------------------+
-+ .. figure:: ../_static/images/max.jpeg                        + .. figure:: ../_static/images/sebastian.jpeg                       +
-+     :width: 120px                                             +     :width: 120px                                                 +
-+                                                               +                                                                   +
-+     `Max Blesch <https://github.com/MaxBlesch>`_              +     `Sebastian Gsell <https://github.com/segsell>`_               +
-+---------------------------------------------------------------+-------------------------------------------------------------------+
-+ .. figure:: ../_static/images/bruno.jpeg                      + .. figure:: ../_static/images/annica.jpeg                          +
-+     :width: 120px                                             +     :width: 120px                                                 +
-+                                                               +                                                                   +
-+     `Bruno Veltri <https://github.com/BVeltri>`_              +     `Annica Gehlen <https://github.com/amageh>`_                  +
-+---------------------------------------------------------------+-------------------------------------------------------------------+
-+ .. figure:: ../_static/images/gregor.png                      + .. figure:: ../_static/images/Frederik.jpeg                        +
-+     :width: 120px                                             +     :width: 120px                                                 +
-+                                                               +                                                                   +
-+     `Gregor Schueler <https://github.com/gregor-schueler>`_   +     `Frederik Emil Larsen <https://github.com/LarsenFred>`_       +
-+---------------------------------------------------------------+-------------------------------------------------------------------+
+.. _team:
+
+
+Team
+=======
+
+
+.. list-table::
+   :widths: 50 50
+   :header-rows: 0
+
+   * - .. figure:: ../_static/images/max.jpeg
+         :width: 120px
+         
+         `Max Blesch <https://github.com/MaxBlesch>`_
+
+     - .. figure:: ../_static/images/sebastian.jpeg
+         :width: 120px
+
+         `Sebastian Gsell <https://github.com/segsell>`_
+
+   * - .. figure:: ../_static/images/bruno.jpeg
+         :width: 120px
+
+         `Bruno Veltri <https://github.com/BVeltri>`_
+
+     - .. figure:: ../_static/images/annica.jpeg
+         :width: 120px
+
+         `Annica Gehlen <https://github.com/amageh>`_
+
+   * - .. figure:: ../_static/images/gregor.png
+         :width: 120px
+
+         `Gregor Schueler <https://github.com/gregor-schueler>`_
+
+     - .. figure:: ../_static/images/Frederik.jpeg
+         :width: 120px
+
+         `Frederik Emil Larsen <https://github.com/LarsenFred>`_

docs/source/index.rst

@@ -35,8 +35,7 @@ savings, including additional discrete choices.
 
    background/limitations
    background/literature
-   background/interface_plots.ipynb
-   background/specify_exogenous_processes.ipynb
+   background/specify_exogenous_processes.md
    background/timing_benchmarks.ipynb