Changeset 9d566b2 in sasview for docs/sphinx-docs

Timestamp:

Jun 13, 2017 12:29:35 PM (8 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

Location:

docs/sphinx-docs

Files:

• build_sphinx.py (modified) (4 diffs)
• source/conf.py (modified) (1 diff)

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.