Changeset 9d566b2 in sasview

Timestamp:

Jun 13, 2017 12:29:35 PM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

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, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

afca488

Parents:

0e2d287

Message:

katex support

Files:

• docs/sphinx-docs/build_sphinx.py (modified) (4 diffs)
• docs/sphinx-docs/source/conf.py (modified) (1 diff)
• src/sas/sasgui/guiframe/documentation_window.py (modified) (3 diffs)

docs/sphinx-docs/build_sphinx.py

@@ -66 +66 @@
 SPHINX_SOURCE_TEST = os.path.join(SPHINX_SOURCE, "test")
 SPHINX_SOURCE_USER = os.path.join(SPHINX_SOURCE, "user")
+KATEX_PARENT = os.path.join(SPHINX_SOURCE, "_static")
+KATEX_PATH = os.path.join(KATEX_PARENT, "katex")
+KATEX_VERSION = "v0.7.1"  # https://github.com/khan/katex/releases
 
 BUMPS_DOCS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..",
@@ -98 +101 @@
     _remove_dir(SPHINX_BUILD)
     _remove_dir(SPHINX_SOURCE)
+    _remove_dir(KATEX_PATH)
     #_remove_dir(SPHINX_SOURCE_GUIFRAME)
     #_remove_dir(SPHINX_SOURCE_MODELS)
@@ -326 +330 @@
 
 
+def fetch_katex(version, destination="_static"):
+    from zipfile import ZipFile
+    import urllib2
+    url = "https://github.com/Khan/KaTeX/releases/download/%s/katex.zip" % version
+    cache_path = "katex_%s.zip" % version
+    if not os.path.exists(cache_path):
+        try:
+            fd_in = urllib2.urlopen(url)
+            with open(cache_path, "wb") as fd_out:
+                fd_out.write(fd_in.read())
+        finally:
+            fd_in.close()
+    with ZipFile(cache_path) as zip:
+        zip.extractall(destination)
+
+
 def retrieve_bumps_docs():
     """
@@ -381 +401 @@
     retrieve_user_docs()
     retrieve_bumps_docs()
+    fetch_katex(version=KATEX_VERSION, destination=KATEX_PARENT)
     apidoc()
     build()

docs/sphinx-docs/source/conf.py

@@ -35 +35 @@
               'sphinx.ext.todo',
               'sphinx.ext.coverage',
-              'sphinx.ext.mathjax',
+              'mathjax',
               'dollarmath',
               'sphinx.ext.viewcode']
+
+STATIC_PATH = '../../_static/'
+mathjax_path = [
+    STATIC_PATH + 'katex/katex.min.js',
+    STATIC_PATH + 'katex/contrib/auto-render.min.js',
+    STATIC_PATH + 'rendermath.js'
+]
+mathjax_css = STATIC_PATH + 'katex/katex.min.css'
+
 
 # Add any paths that contain templates here, relative to this directory.

src/sas/sasgui/guiframe/documentation_window.py

@@ -16 +16 @@
 import os
 import logging
-import wx
 import webbrowser
 import urllib
 import sys
 
+import wx
+try:
+    import wx.html2 as html
+    WX_SUPPORTS_HTML2 = True
+except ImportError:
+    WX_SUPPORTS_HTML2 = False
+
+from .gui_manager import get_app_dir
+
 logger = logging.getLogger(__name__)
 
 SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
-WX_SUPPORTS_HTML2 = True
-try:
-    import wx.html2 as html
-except:
-    WX_SUPPORTS_HTML2 = False
 
+THREAD_STARTED = False
+def start_documentation_server(doc_root, port):
+    import thread
+    global THREAD_STARTED
+    if not THREAD_STARTED:
+        thread.start_new_thread(_documentation_server, (doc_root, port))
+        THREAD_STARTED = True
 
-from gui_manager import get_app_dir
+def _documentation_server(doc_root, port):
+    from SimpleHTTPServer import SimpleHTTPRequestHandler
+    from SocketServer import TCPServer
 
+    os.chdir(doc_root)
+    httpd = TCPServer(("127.0.0.1", port), SimpleHTTPRequestHandler, bind_and_activate=False)
+    httpd.allow_reuse_address = True
+    try:
+        httpd.server_bind()
+        httpd.server_activate()
+        httpd.serve_forever()
+    finally:
+        httpd.server_close()
 
 class DocumentationWindow(wx.Frame):
@@ -70 +91 @@
         #Note added June 21, 2015     PDB
         file_path = os.path.join(docs_path, path)
-        url = "file:///" + urllib.quote(file_path, r'/\:')+ url_instruction
-
-        if not os.path.exists(file_path):
+        if path.startswith('http'):
+            url = path
+        elif not os.path.exists(file_path):
+            url = "index.html"
             logger.error("Could not find Sphinx documentation at %s \
             -- has it been built?", file_path)
-        elif WX_SUPPORTS_HTML2:
+        elif True:
+            start_documentation_server(docs_path, port=7999)
+            url = "http://localhost:7999/" + path.replace('\\', '/') + url_instruction
+        else:
+            url = "file:///" + urllib.quote(file_path, r'/\:')+ url_instruction
+
+        logger.info("showing url " + url)
+        if WX_SUPPORTS_HTML2:
             # Complete HTML/CSS support!
             self.view = html.WebView.New(self)
             self.view.LoadURL(url)
+            self.Bind(html.EVT_WEBVIEW_ERROR, self.OnError, self.view)
             self.Show()
         else:
@@ -88 +118 @@
             webbrowser.open_new_tab(url)
 
+    def OnError(self, evt):
+        logger.error("%d: %s", evt.GetInt(), evt.GetString())
+
 def main():
     """
     main loop function if running alone for testing.
     """
+    url = "index.html" if len(sys.argv) <= 1 else sys.argv[1]
     app = wx.App()
-    DocumentationWindow(None, -1, "index.html", "", "Documentation",)
+    DocumentationWindow(None, -1, url, "", "Documentation",)
     app.MainLoop()