Merge pull request #1237 from TimBartholomew/doc_dependencies

Adding documentation section for optional dependencies

docs/advanced_user_guide/advanced_install/index.rst

@@ -1,7 +1,7 @@
 Advanced User Installation
 ==========================
 
-Advanced users who plan to develop their own models or tools are encouraged to install IDAES using Git and GitHub as described in this section, rather than using the instructions in the :ref:`getting started<getting_started:Getting Started>` section. These advanced users will greatly benefit from improved version control and code integration capabilities.
+Advanced users who plan to develop their own models or tools are encouraged to install IDAES using Git and GitHub as described in this section, rather than using the instructions in the :ref:`getting started<getting_started/index:Getting Started>` section. These advanced users will greatly benefit from improved version control and code integration capabilities.
 
 .. contents:: :local:
 
@@ -71,7 +71,7 @@ Create the Python Environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Once you have the repo cloned, you can change into that directory (by default, it will be called "idaes-pse" like the repo) and install the Python packages.
 
-But before you do that, you need to get the Python package manager fully up and running. We use a Python packaging system called Conda_ and we specifically use its minimal version Miniconda_. If you do not already have Conda, please follow the installation instructions for your operating system in :ref:`getting started<getting_started:Getting Started>`.
+But before you do that, you need to get the Python package manager fully up and running. We use a Python packaging system called Conda_ and we specifically use its minimal version Miniconda_. If you do not already have Conda, please follow the installation instructions for your operating system in :ref:`getting started<getting_started/index:Getting Started>`.
 
 .. _Conda: https://conda.io/
 .. _Miniconda: https://conda.io/en/latest/miniconda.html

docs/getting_started.rst → docs/getting_started/index.rst

@@ -117,7 +117,7 @@ Powershell Prompt.  Regardless of OS and shell, the following steps are the same
 
     pip install idaes-pse
 
-2. Run the :doc:`idaes get-extensions command<user_guide/commands/get_extensions>`
+2. Run the :doc:`idaes get-extensions command<../user_guide/commands/get_extensions>`
    to install the compiled binaries::
 
     idaes get-extensions
@@ -131,7 +131,7 @@ Powershell Prompt.  Regardless of OS and shell, the following steps are the same
                 conda-forge ipopt`` though this will not have all the features
                 of our extentions package.
 
-3. Run the :doc:`idaes get-examples command <user_guide/commands/get_examples>` to download
+3. Run the :doc:`idaes get-examples command <../user_guide/commands/get_examples>` to download
    and install the example files::
 
     idaes get-examples
@@ -150,7 +150,7 @@ Powershell Prompt.  Regardless of OS and shell, the following steps are the same
 
         idaes get-examples --dir C:\Users\MyName\IDAES\Examples
 
-    Refer to the full :doc:`idaes get-examples command documentation <user_guide/commands/get_examples>`
+    Refer to the full :doc:`idaes get-examples command documentation <../user_guide/commands/get_examples>`
     for more information.
 
 4. Run tests::
@@ -162,3 +162,14 @@ Powershell Prompt.  Regardless of OS and shell, the following steps are the same
    error handling. The number of tests that failed and succeeded is reported at the end of the pytest
    output. You can report problems on the |github-issues|
    (Please try to be specific about the command and the offending output.)
+
+Optional Dependencies
+---------------------
+Some tools in IDAES may require additional dependencies. Instructions for installing these dependencies 
+are located :ref:`here<getting_started/opt_dependencies:Optional Dependencies>`.
+
+.. toctree::
+    :glob:
+    :hidden:
+
+    *

docs/getting_started/opt_dependencies.rst

@@ -0,0 +1,3 @@
+Optional Dependencies
+=====================
+(content will be added soon)

docs/index.rst

@@ -41,7 +41,7 @@ Contents
 .. toctree::
     :maxdepth: 2
 
-    getting_started
+    getting_started/index
     user_guide/index
     advanced_user_guide/index
     tutorials_examples

docs/user_guide/vis/index.rst

@@ -18,7 +18,7 @@ models, streams, and stream labels.
 Installation instructions
 -------------------------
 
-1. :ref:`Ensure that the latest IDAES is installed. <getting_started:Installation>` 
+1. :ref:`Ensure that the latest IDAES is installed. <getting_started/index:Installation>` 
 
 .. _usage: