Adding troubleshooting section and reworked the toc

envi-idl · Aug 16, 2017 · 3061196 · 3061196
1 parent 058d14d
commit 3061196
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 11 deletions.
diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -1,5 +1,8 @@
 .. ENVI Py for ArcGIS API
 
+*****************
+API Documentation
+*****************
 
 ENVI GPToolbox
 ==============

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -45,7 +45,7 @@
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'toc'
 
 # General information about the project.
 project = u'ENVI Py for ArcGIS'

diff --git a/doc/source/images/arcgispro_template_version.png b/doc/source/images/arcgispro_template_version.png
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,3 +1,4 @@
+
 .. _envipyarc:
 
 ******************
@@ -18,6 +19,8 @@ To operate, ENVI Py for Arcgis requires the following:
 * ENVI 5.3SP2 or later
 * ArcMap 10.4 or later and/or ArcGIS Pro 1.3 or later
 
+.. _envipyarc-installation-and-configuration:
+
 Installation and Configuration
 ==============================
 
@@ -182,14 +185,4 @@ Run the toolbox.
     >>> print(result)
 
 
-API Documentation
-=================
-
-.. toctree::
-   :maxdepth: 2
-
-   api
-
-
-
 
diff --git a/doc/source/toc.rst b/doc/source/toc.rst
@@ -0,0 +1,7 @@
+
+.. toctree::
+    :maxdepth: 2
+
+    index
+    api
+    troubleshooting
diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst
@@ -0,0 +1,22 @@
+
+***************
+Troubleshooting
+***************
+
+
+No option engine in section: envipyengine
+=========================================
+
+This error means the ENVI Py installation has not been configured to point to your ENVI/IDL taskengine executable.  Before running any task or GPTool, make sure you have completed the steps in the :ref:`envipyarc-installation-and-configuration` section which sets the path to the ENVI taskengine.
+
+
+
+This document was created using a newer version of ArcGIS Pro
+=============================================================
+
+when opening the project template in ArcGIS Pro version 1.3 or earlier, you will get this warning message about dropping unsupported features.
+
+.. image:: images/arcgispro_template_version.png
+
+The project templates provided are built with ArcGIS Pro 1.4 and package the python toolboxes so they are easily accessible. The templates are supported for ArcGIS 1.2 or newer and no features will be downgraded or dropped.
+