Changeset a4340d1 in sasview

Timestamp:

Feb 17, 2015 8:01:09 AM (9 years ago)

Author:

butler

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

0c4bca6

Parents:

296f290

Message:

Restructure the way the new help documentation gets displayed

1) Make the _onSphinxDocumentation a single line instatiation of
documentation_window passing only the location within the documentation
tree instead of the whol documentation path.

2) Put all the logic in documentation_window to check for 2.9 or higher

3) If lower than 2.9 go to same documentation but open with broswer (no
longer requires a connection)

4) Fix logging string so if the path is not found it fails but sends a
logging string to the log

Location:

src/sas/guiframe

Files:

• documentation_window.py (modified) (2 diffs)
• gui_manager.py (modified) (3 diffs)

src/sas/guiframe/documentation_window.py

@@ +1 @@
+import os
+import logging
 import wx
 from wx import Frame
-
+import webbrowser
 wx_supports_html2 = float(wx.__version__[:3]) >= 2.9
 if wx_supports_html2:
@@ -8 +10 @@
     import wx.html as html
 
+   
 class DocumentationWindow(Frame):
     def __init__(self, parent, id, path, title='Help', size=(850, 540)):
         Frame.__init__(self, parent, id, title, size=size)
 
-        if wx_supports_html2:
+        SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
+        if SPHINX_DOC_ENV in os.environ:
+            docs_path = os.path.join(os.environ[SPHINX_DOC_ENV])
+        else:
+            docs_path = os.path.join(PATH_APP, "..", "..", "doc")
+
+        if (not os.path.exists(docs_path)):
+            print "logging"
+            logging.error("Could not find Sphinx documentation at %s \
+            -- has it been built?", docs_path)
+
+        elif wx_supports_html2:
             # Complete HTML/CSS support!
             self.view = html.WebView.New(self)
-            self.view.LoadURL("file://" + path)
-        else:
-            # This ain't gonna be pretty...
-            self.view = html.HtmlWindow(self, -1, style=wx.NO_BORDER)
-            self.view.LoadPage(path)
+            self.view.LoadURL("file://" + docs_path + '\\' + path)
+            self.Show()
+        else: 
+            #For cases that do not build against current version dependency
+            # Wx 3.0 we provide a webbrowser call - this is particularly for 
+            #Red hat used at SNS for which Wx 3.0 is not available.  This
+            #does not deal with issue of math in docs of course. 
+
+            webbrowser.open_new_tab("file:///" + docs_path + "/" + path)
+
+ 

src/sas/guiframe/gui_manager.py

@@ -24 +24 @@
 import logging
 import httplib
-import webbrowser
 
 
@@ -2153 +2152 @@
     def _onSphinxDocs(self, evt):
         """
-        Bring up Sphinx Documentation.  If Wx 2.9 or higher is installed 
-        with proper HTML support then Pop up a Sphinx Documentation dialog
-        locally.  If not pop up a new tab in the default system browser 
-        calling the documentation website.
+        Bring up Sphinx Documentation at top level whenever the menu item
+        'documentation' is clicked. Calls DocumentationWindow with the top
+        level path of "index.html"
         
         :param evt: menu event
@@ -2162 +2160 @@
         # Running SasView "in-place" using run.py means the docs will be in a
         # different place than they would otherwise.
-
-        show_sphinx_docs = float(wx.__version__[:3]) >= 2.9
-        if show_sphinx_docs:
-            SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
-            if SPHINX_DOC_ENV in os.environ:
-                docs_path = os.path.join(os.environ[SPHINX_DOC_ENV], "index.html")
-            else:
-                docs_path = os.path.join(PATH_APP, "..", "..", "doc", "index.html")
-
-            if os.path.exists(docs_path):
-                from documentation_window import DocumentationWindow
-
-                sphinx_doc_viewer = DocumentationWindow(None, -1, docs_path)
-                sphinx_doc_viewer.Show()
-            else:
-                logging.error("Could not find Sphinx documentation at '%' -- has it been built?" % docs_path)
-        else:
-            #For red hat and maybe others who do not have Wx 3.0
-            #just send to webpage of documentation
-            webbrowser.open_new_tab('http://www.sasview.org/sasview')
+        from documentation_window import DocumentationWindow
+        
+        sphinx_doc_viewer = DocumentationWindow(self, -1, "index.html")
+#        sphinx_doc_viewer.Show()
+
 
     def set_manager(self, manager):