Add Intersphinx (#132)

* Intersphinx config, script, and example * Run config update and better help * simplify with yaml parse * Delete scripts/update_intersphinx_mapping.py * Added pyomo link --------- Co-authored-by: Ludovico Bianchi <[email protected]>
IDAES · Sep 5, 2024 · 50338e0 · 50338e0
1 parent 8f46f82
commit 50338e0
Show file tree

Hide file tree

Showing 7 changed files with 1,832 additions and 1,817 deletions.
diff --git a/idaes_examples/notebooks/_config.yml b/idaes_examples/notebooks/_config.yml
@@ -13,8 +13,23 @@ sphinx:
   config:
     bibtex_reference_style: author_year
     exclude_patterns: ['**/.jupyter_cache']
-title: IDAES Examples
-repository:
+    intersphinx_mapping:
+      idaes:
+      - https://idaes-pse.readthedocs.io/en/stable/
+      - null
+      idaes-examples:
+      - https://idaes-examples.readthedocs.io/en/stable/
+      - null
+      prommis:
+      - https://prommis.readthedocs.io/en/stable/
+      - null
+      watertap:
+      - https://watertap.readthedocs.io/en/stable/
+      - null
+      pyomo:
+      - https://pyomo.readthedocs.io/en/stable/
+      - null
+
   # `path_to_book` should point to the directory containing this file (`_config.yml`)
   path_to_book: idaes_examples/notebooks
   # FIXME change `url` and `branch` before merging PR

diff --git a/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox.ipynb b/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox.ipynb
@@ -40,7 +40,7 @@
     "\n",
     "Model diagnosis and debugging is often more of an art than a science, and it generally relies on significant experience and understanding both of general EO modeling techniques and the specific model and problem being solved. To assist with this process, IDAES has developed a model diagnostics toolbox that brings together a large number of tools for identifying potential issues in a model to help guide the user through the process of finding and resolving these issues. Note however that whilst these tools can help identify the presence of an issue, remedying the issue always requires some degree of engineering knowledge about the system being modeled, and thus it is ultimately up to the user to find a solution to the problem.\n",
     "\n",
-    "This tutorial will take you through using the ``DiagnosticsToolbox`` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
+    "This tutorial will take you through using the {py:class}`DiagnosticsToolbox <idaes.core.util.model_diagnostics.DiagnosticsToolbox>` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
     "\n",
     "To get started, the ``DiagnosticsToolbox`` can be imported from ``idaes.core.util``.\n",
     "\n",

diff --git a/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_doc.ipynb b/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_doc.ipynb
diff --git a/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_exercise.ipynb b/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_exercise.ipynb
@@ -38,7 +38,7 @@
         "\n",
         "Model diagnosis and debugging is often more of an art than a science, and it generally relies on significant experience and understanding both of general EO modeling techniques and the specific model and problem being solved. To assist with this process, IDAES has developed a model diagnostics toolbox that brings together a large number of tools for identifying potential issues in a model to help guide the user through the process of finding and resolving these issues. Note however that whilst these tools can help identify the presence of an issue, remedying the issue always requires some degree of engineering knowledge about the system being modeled, and thus it is ultimately up to the user to find a solution to the problem.\n",
         "\n",
-        "This tutorial will take you through using the ``DiagnosticsToolbox`` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
+        "This tutorial will take you through using the {py:class}`DiagnosticsToolbox <idaes.core.util.model_diagnostics.DiagnosticsToolbox>` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
         "\n",
         "To get started, the ``DiagnosticsToolbox`` can be imported from ``idaes.core.util``.\n",
         "\n",
@@ -783,4 +783,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 3
-}
+}
diff --git a/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_solution.ipynb b/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_solution.ipynb
@@ -38,7 +38,7 @@
         "\n",
         "Model diagnosis and debugging is often more of an art than a science, and it generally relies on significant experience and understanding both of general EO modeling techniques and the specific model and problem being solved. To assist with this process, IDAES has developed a model diagnostics toolbox that brings together a large number of tools for identifying potential issues in a model to help guide the user through the process of finding and resolving these issues. Note however that whilst these tools can help identify the presence of an issue, remedying the issue always requires some degree of engineering knowledge about the system being modeled, and thus it is ultimately up to the user to find a solution to the problem.\n",
         "\n",
-        "This tutorial will take you through using the ``DiagnosticsToolbox`` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
+        "This tutorial will take you through using the {py:class}`DiagnosticsToolbox <idaes.core.util.model_diagnostics.DiagnosticsToolbox>` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
         "\n",
         "To get started, the ``DiagnosticsToolbox`` can be imported from ``idaes.core.util``.\n",
         "\n",
@@ -2101,4 +2101,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 3
-}
+}
diff --git a/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_test.ipynb b/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_test.ipynb
@@ -38,7 +38,7 @@
         "\n",
         "Model diagnosis and debugging is often more of an art than a science, and it generally relies on significant experience and understanding both of general EO modeling techniques and the specific model and problem being solved. To assist with this process, IDAES has developed a model diagnostics toolbox that brings together a large number of tools for identifying potential issues in a model to help guide the user through the process of finding and resolving these issues. Note however that whilst these tools can help identify the presence of an issue, remedying the issue always requires some degree of engineering knowledge about the system being modeled, and thus it is ultimately up to the user to find a solution to the problem.\n",
         "\n",
-        "This tutorial will take you through using the ``DiagnosticsToolbox`` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
+        "This tutorial will take you through using the {py:class}`DiagnosticsToolbox <idaes.core.util.model_diagnostics.DiagnosticsToolbox>` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
         "\n",
         "To get started, the ``DiagnosticsToolbox`` can be imported from ``idaes.core.util``.\n",
         "\n",
@@ -1862,4 +1862,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 3
-}
+}
diff --git a/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_usr.ipynb b/idaes_examples/notebooks/docs/diagnostics/diagnostics_toolbox_usr.ipynb
@@ -38,7 +38,7 @@
         "\n",
         "Model diagnosis and debugging is often more of an art than a science, and it generally relies on significant experience and understanding both of general EO modeling techniques and the specific model and problem being solved. To assist with this process, IDAES has developed a model diagnostics toolbox that brings together a large number of tools for identifying potential issues in a model to help guide the user through the process of finding and resolving these issues. Note however that whilst these tools can help identify the presence of an issue, remedying the issue always requires some degree of engineering knowledge about the system being modeled, and thus it is ultimately up to the user to find a solution to the problem.\n",
         "\n",
-        "This tutorial will take you through using the ``DiagnosticsToolbox`` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
+        "This tutorial will take you through using the {py:class}`DiagnosticsToolbox <idaes.core.util.model_diagnostics.DiagnosticsToolbox>` to debug a number of issues in a simple Pyomo model and to take it from initially reporting a possible infeasible solution to returning the correct solution.\n",
         "\n",
         "To get started, the ``DiagnosticsToolbox`` can be imported from ``idaes.core.util``.\n",
         "\n",
@@ -2101,4 +2101,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 3
-}
+}