From f7a5201125e2817587da9238ae7736065d6b9b1a Mon Sep 17 00:00:00 2001
From: Dan Gunter <dkgunter@lbl.gov>
Date: Wed, 20 Sep 2023 16:28:34 -0700
Subject: [PATCH] Add UI Page (#1269)

* Beginnings of UI page

* ui doc links

* add build.os key

* rtd yaml
---
 .readthedocs.yml                          |  7 ++++++-
 docs/explanations/components/ui/index.rst | 12 ++++++++++++
 docs/how_to_guides/opt_dependencies.rst   |  2 +-
 docs/index.rst                            |  1 +
 docs/reference_guides/index.rst           |  2 ++
 5 files changed, 22 insertions(+), 2 deletions(-)
 create mode 100644 docs/explanations/components/ui/index.rst

diff --git a/.readthedocs.yml b/.readthedocs.yml
index 742dd218ed..56b2210888 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -5,11 +5,16 @@
 # Required
 version: 2
 
+# Build settings
+build:
+  os: ubuntu-22.04
+  tools:
+      python: "3.11"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
     fail_on_warning: false
 
 python:
-    version: "3.8"
     install:
         - requirements: requirements-dev.txt
diff --git a/docs/explanations/components/ui/index.rst b/docs/explanations/components/ui/index.rst
new file mode 100644
index 0000000000..36a62674c8
--- /dev/null
+++ b/docs/explanations/components/ui/index.rst
@@ -0,0 +1,12 @@
+User Interfaces
+===============
+
+There are several types of user interfaces in IDAES.
+To learn more about them, follow the links below.
+
+* Graphical user interfaces: see `Flowsheet Visualizer <https://idaes-ui.readthedocs.io/en/latest/fv.html>`_
+* `Jupyter Notebooks <https://jupyter.org/>`_: see `IDAES Examples <https://idaes-examples.readthedocs.io/en/latest/>`_
+* Python Application Programming Interfaces (APIs): see :ref:`API Reference`
+
+
+
diff --git a/docs/how_to_guides/opt_dependencies.rst b/docs/how_to_guides/opt_dependencies.rst
index 3ac98d3045..f763cb065c 100644
--- a/docs/how_to_guides/opt_dependencies.rst
+++ b/docs/how_to_guides/opt_dependencies.rst
@@ -27,7 +27,7 @@ Available optional dependencies targets
 
 As of IDAES 2.1, the following ``extras_require`` targets are available:
 
-* ``ui``: for the `IDAES User Interface (UI) <https://github.com/IDAES/idaes-ui>`_
+* ``ui``: for the `IDAES User Interface (UI) <https://github.com/IDAES/idaes-ui>`_ (`UI documentation <https://idaes-ui.readthedocs.io/en/latest/>`_)
 * ``dmf``: for the :ref:`Data Management Framework <dmf-overview>`
 * ``grid``: for the :ref:`IDAES Grid integration <idaes-grid>`
 * ``omlt``: for the :ref:`OMLT integration <omlt>`
diff --git a/docs/index.rst b/docs/index.rst
index 4c07f74d51..f0294d470f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -32,6 +32,7 @@ See also :doc:`IDAES concepts <explanations/concepts>` in this documentation.
          | :doc:`Why IDAES <explanations/why_idaes>`
          | :doc:`Concepts <explanations/concepts>`
          | :doc:`Components of IDAES <explanations/components/index>`
+         | :doc:`User Interfaces <explanations/components/ui/index>`
          | :doc:`Conventions <explanations/conventions>`
          | :doc:`Model Diagnostics Workflow <explanations/model_diagnostics/index>`
          | :doc:`Modeling Extensions <explanations/modeling_extensions/index>`
diff --git a/docs/reference_guides/index.rst b/docs/reference_guides/index.rst
index 9a813b88d5..e8c60d539b 100644
--- a/docs/reference_guides/index.rst
+++ b/docs/reference_guides/index.rst
@@ -1,3 +1,5 @@
+.. _API Reference:
+
 Reference Guides
 =================