Changeset e8af9b1 in sasview for src/sas/guiframe

Timestamp:

Jun 21, 2015 12:08:09 AM (10 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:

d20eb45

Parents:

d896039

Message:

pylint cleanup and fix of mac documentation

File:

• src/sas/guiframe/documentation_window.py (modified) (4 diffs)

src/sas/guiframe/documentation_window.py

@@ +1 @@
+"""
+documentation module provides a simple means to add help throughout the 
+application. It checks for the existence of html2 package needed to support
+fully html panel which supports css.  The class defined here takes a title for
+the particular help panel, a pointer to the html documentation file of interest
+within the documentation tree along with a 'command' string such as a page
+anchor or a query string etc.  The path to the doc directory is retrieved
+automatically by the class itself.  Thus with these three pieces of information
+the class generates a panel with the appropriate title bar and help file
+formatted according the style sheets called in the html file.  Finally, if an
+old version of Python is running and the html2 package is not available the
+class brings up the default browser and passes the file:/// string to it.  In
+this case however the instruction portion is usually not passed for security
+reasons. 
+"""
 import sys
 import os
@@ -6 +21 @@
 import urllib
 
-wx_supports_html2 = True
+SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
+WX_SUPPORTS_HTML2 = True
 try:
     import wx.html2 as html
 except:
-    wx_supports_html2 = False
+    WX_SUPPORTS_HTML2 = False
 if sys.platform.count("win32") > 0:
     #this is a PC
-    wx_supports_html2 = True
+    WX_SUPPORTS_HTML2 = True
 else:
     #this is a MAC
-    wx_supports_html2 = False
-
-
+    WX_SUPPORTS_HTML2 = False
 
 from gui_manager import get_app_dir
@@ -24 +38 @@
 
 class DocumentationWindow(wx.Frame):
-    def __init__(self, parent, id, path, url_instruction, title, size=(850, 540)):
-        wx.Frame.__init__(self, parent, id, title, size=size)
+    def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)):
+        wx.Frame.__init__(self, parent, dummy_id, title, size=size)
 
-        SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
         if SPHINX_DOC_ENV in os.environ:
             docs_path = os.path.join(os.environ[SPHINX_DOC_ENV])
@@ -37 +50 @@
 
         file_path = os.path.join(docs_path, path)
-        url = "file:///" + urllib.quote(file_path,'\:')+ url_instruction
+        url = "file:///" + urllib.quote(file_path, '/\:')+ url_instruction
 
         if not os.path.exists(file_path):
             logging.error("Could not find Sphinx documentation at %s \
             -- has it been built?", file_path)
-        elif wx_supports_html2:
+        elif WX_SUPPORTS_HTML2:
             # Complete HTML/CSS support!
             self.view = html.WebView.New(self)
             self.view.LoadURL(url)
             self.Show()
-        else: 
+        else:
             logging.error("No html2 support, popping up a web browser")
             #For cases that do not build against current version dependency
-            # Wx 3.0 we provide a webbrowser call - this is particularly for 
+            # 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. 
+            #does not deal with issue of math in docs of course.
             webbrowser.open_new_tab(url)