Changeset c3437260 in sasview

Timestamp:

Nov 30, 2014 11:06:12 AM (10 years ago)

Author:

Peter Parker

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:

70a9d1c

Parents:

9729a6d

Message:

Refs #221 - Add extra help menu item if wxPython 2.9 or higher is present. This button just opens up a viewer on the index.html page of the Sphinx documentation. Note the slight implementation detail of using os.environ to track whether or not run.py has been used to run SasView? 'in-place'. In this case the documentation is in a different place relative to the main sansview.py entry point of the program.

Files:

• run.py (modified) (2 diffs)
• src/sans/guiframe/documentation_window.py (added)
• src/sans/guiframe/gui_manager.py (modified) (4 diffs)

run.py

@@ -67 +67 @@
     #import numpy; numpy.seterr(all='raise')
 
+    # Notify the help menu that the Sphinx documentation is in a different 
+    # place than it otherwise would be.
+
+    
+
     # find the directories for the source and build
     from distutils.util import get_platform
@@ -72 +77 @@
     platform = '%s-%s'%(get_platform(),sys.version[:3])
     build_path = joinpath(root, 'build','lib.'+platform)
+
+    os.environ['SASVIEW_DOC_PATH'] = joinpath(build_path, "doc")
 
     # Make sure that we have a private version of mplconfig

src/sans/guiframe/gui_manager.py

@@ -1330 +1330 @@
         self._help_menu = wx.Menu()
         style = self.__gui_style & GUIFRAME.WELCOME_PANEL_ON
+
         if style == GUIFRAME.WELCOME_PANEL_ON or custom_config != None:
             # add the welcome panel menu item
@@ -1337 +1338 @@
                 self._help_menu.AppendSeparator()
                 wx.EVT_MENU(self, id, self.show_welcome_panel)
+
         # Look for help item in plug-ins 
         for item in self.plugins:
@@ -1343 +1345 @@
                 self._help_menu.Append(id,'&%s Help' % item.sub_menu, '')
                 wx.EVT_MENU(self, id, item.help)
+
+        # Only show new Sphinx docs link if version of wx supports displaying
+        # it correctly.
+        show_sphinx_docs = float(wx.__version__[:3]) >= 2.9
+        if show_sphinx_docs:
+            self._help_menu.AppendSeparator()
+            id = wx.NewId()
+            self._help_menu.Append(id, '&Sphinx Documentation', '')
+            wx.EVT_MENU(self, id, self._onSphinxDocs)
+
         if config._do_tutorial and (IS_WIN or sys.platform =='darwin'):
             self._help_menu.AppendSeparator()
@@ -2148 +2160 @@
                         wx.MessageBox(msg, 'Error')
 
-                      
+    def _onSphinxDocs(self, evt):
+        """
+        Pop up a Sphinx Documentation dialog.
+        
+        :param evt: menu event
+        """
+        # Running SasView "in-place" using run.py means the docs will be in a
+        # different place than they would otherwise.
+        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)
+
     def set_manager(self, manager):
         """