source: sasview/src/sas/guiframe/documentation_window.py @ a12c0a6

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since a12c0a6 was a12c0a6, checked in by butler, 9 years ago

some docstring edits

  • Property mode set to 100644
File size: 4.2 KB
Line 
1"""
2documentation module provides a simple means to add help throughout the
3application. It checks for the existence of html2 package needed to support
4fully html panel which supports css.  The class defined here takes a title for
5the particular help panel, a pointer to the html documentation file of interest
6within the documentation tree along with a 'command' string such as a page
7anchor or a query string etc.  The path to the doc directory is retrieved
8automatically by the class itself.  Thus with these three pieces of information
9the class generates a panel with the appropriate title bar and help file
10formatted according the style sheets called in the html file.  Finally, if an
11old version of Python is running and the html2 package is not available the
12class brings up the default browser and passes the file:/// string to it.  In
13this case however the instruction portion is usually not passed for security
14reasons.
15"""
16import os
17import logging
18import wx
19import webbrowser
20import urllib
21import sys
22
23SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
24WX_SUPPORTS_HTML2 = True
25try:
26    import wx.html2 as html
27except:
28    WX_SUPPORTS_HTML2 = False
29
30
31from gui_manager import get_app_dir
32
33
34class DocumentationWindow(wx.Frame):
35    """
36    DocumentationWindow inherits from wx.Frame and provides a centralized
37    coherent framework for all help documentation.  Help files must be html
38    files stored in an properly organized tree below the top 'doc' folder.  In
39    order to display the appropriate help file from anywhere in the gui, the
40    code simply needs to know the location below the top level where the
41    help file resides along with the name of the help file.
42    called
43    (self, parent, dummy_id, path, url_instruction, title, size=(850, 540))
44
45    :param path: path to html file beginning AFTER /doc/ and ending in the
46    file.html.
47   
48    :param url_instructions: anchor string or other query e.g. '#MyAnchor'
49    :param title: text to place in the title bar of the help panel
50    """
51    def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)):
52        wx.Frame.__init__(self, parent, dummy_id, title, size=size)
53
54        if SPHINX_DOC_ENV in os.environ:
55            docs_path = os.path.join(os.environ[SPHINX_DOC_ENV])
56        else:
57            # For the installer, docs are in a top-level directory.  We're not
58            # bothering to worry about docs when running using the old
59            # (non - run.py) way.
60            docs_path = os.path.join(get_app_dir(), "doc")
61
62        #note that filepath for mac OS, at least in bundle starts with a
63        #forward slash as /Application, while the PC string begins C:\
64        #It seems that mac OS is happy with four slashes as in file:////App...
65        #Two slashes is not sufficient to indicate path from root.  Thus for now
66        #we use "file:///" +... If the mac behavior changes may need to make the
67        #file:/// be another constant at the beginning that yields // for Mac
68        #and /// for PC.
69        #Note added June 21, 2015     PDB
70        file_path = os.path.join(docs_path, path)
71        url = "file:///" + urllib.quote(file_path, r'/\:')+ url_instruction
72
73        if not os.path.exists(file_path):
74            logging.error("Could not find Sphinx documentation at %s \
75            -- has it been built?", file_path)
76        elif WX_SUPPORTS_HTML2:
77            # Complete HTML/CSS support!
78            self.view = html.WebView.New(self)
79            self.view.LoadURL(url)
80            self.Show()
81        else:
82            logging.error("No html2 support, popping up a web browser")
83            #For cases that do not build against current version dependency
84            # Wx 3.0 we provide a webbrowser call - this is particularly for
85            #Red hat used at SNS for which Wx 3.0 is not available.  This
86            #does not deal with issue of math in docs of course.
87            webbrowser.open_new_tab(url)
88
89def main():
90    """
91    main loop function if running alone for testing.
92    """
93    app = wx.App()
94    DocumentationWindow(None, -1, "index.html", "", "Documentation",)
95    app.MainLoop()
96
97if __name__ == '__main__':
98    main()
Note: See TracBrowser for help on using the repository browser.