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 `_ +* `Jupyter Notebooks `_: see `IDAES Examples `_ +* 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) `_ +* ``ui``: for the `IDAES User Interface (UI) `_ (`UI documentation `_) * ``dmf``: for the :ref:`Data Management Framework ` * ``grid``: for the :ref:`IDAES Grid integration ` * ``omlt``: for the :ref:`OMLT integration ` 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 ` in this documentation. | :doc:`Why IDAES ` | :doc:`Concepts ` | :doc:`Components of IDAES ` + | :doc:`User Interfaces ` | :doc:`Conventions ` | :doc:`Model Diagnostics Workflow ` | :doc:`Modeling Extensions ` 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 =================