Changeset c1e44e5 in sasmodels for doc

Timestamp:

Mar 30, 2019 1:59:45 AM (6 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master

Children:

a42b091

Parents:

663d2a8

Message:

Add local link to source files. Refs #1263.

Location:

doc

Files:

• conf.py (modified) (1 diff)
• genmodel.py (modified) (3 diffs)

doc/conf.py

@@ -36 +36 @@
               #'only_directives',
               #'matplotlib.sphinxext.mathmpl',
-              'matplotlib.sphinxext.only_directives',
+              #'matplotlib.sphinxext.only_directives',
               'matplotlib.sphinxext.plot_directive',
               'dollarmath',

doc/genmodel.py

@@ -7 +7 @@
 import matplotlib.pyplot as plt
 sys.path.insert(0, os.path.abspath('..'))
+import sasmodels
 from sasmodels import generate, core
 from sasmodels.direct_model import DirectModel, call_profile
@@ -127 +128 @@
     #print("figure saved in",path)
 
+def copy_if_newer(src, dst):
+    from os.path import dirname, exists, getmtime
+    import shutil
+    if not exists(dst):
+        path = dirname(dst)
+        if not exists(path):
+            os.makedirs(path)
+        shutil.copy2(src, dst)
+    elif getmtime(src) > getmtime(dst):
+        shutil.copy2(src, dst)
+
+def link_sources(model_info):
+    from os.path import basename, dirname, realpath, join as joinpath
+
+    # List source files in reverse order of dependency.
+    model_file = basename(model_info.filename)
+    sources = list(reversed(model_info.source + [model_file]))
+
+    # Copy files to src dir under models directory.  Need to do this
+    # because sphinx can't link to an absolute path.
+    root = dirname(dirname(realpath(__file__)))
+    src = joinpath(root, "sasmodels", "models")
+    dst = joinpath(root, "doc", "model", "src")
+    for path in sources:
+        copy_if_newer(joinpath(src, path), joinpath(dst, path))
+
+    # Link to local copy of the files
+    downloads = [":download:`%s <src/%s>`"%(path, path) for path in sources]
+
+    # Link to github repo (either the tagged sasmodels version or master)
+    url = "https://github.com/SasView/sasmodels/blob/v%s"%sasmodels.__version__
+    #url = "https://github.com/SasView/sasmodels/blob/master"%sasmodels.__version__
+    links = ["`%s <%s/sasmodels/models/%s>`_"%(path, url, path) for path in sources]
+
+    sep = u"\n\\ \u25E6 \\ "  # bullet
+    body = "\n**Source**\n"
+    #body += "\n\\ " + sep.join(links) + "\n\n"
+    body += "\n\\ " + sep.join(downloads) + "\n\n"
+    return body
+
 def gen_docs(model_info):
     # type: (ModelInfo) -> None
@@ -150 +191 @@
     match = re.search(pattern, docstr.upper())
 
+    sources = link_sources(model_info)
+
+    insertion = captionstr + sources
+
     if match:
         docstr1 = docstr[:match.start()]
         docstr2 = docstr[match.start():]
-        docstr = docstr1 + captionstr + docstr2
+        docstr = docstr1 + insertion + docstr2
     else:
         print('------------------------------------------------------------------')
         print('References NOT FOUND for model: ', model_info.id)
         print('------------------------------------------------------------------')
-        docstr += captionstr
+        docstr += insertion
 
     open(sys.argv[2],'w').write(docstr)