Changeset 0d5dc05 in sasmodels for doc/genmodel.py

Timestamp:

Mar 31, 2019 7:33:49 AM (6 years ago)

Author:

GitHub <noreply@…>

Branches:

master

Children:

f8060c5

Parents:

be0942c (diff), 7050455 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

Steve K <smk78@…> (03/31/19 07:33:49)

git-committer:

GitHub <noreply@…> (03/31/19 07:33:49)

Message:

Merge branch 'master' into ticket-1263-source-link

File:

• doc/genmodel.py (modified) (3 diffs)

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]
+
+    # Could do syntax highlighting on the model files by creating a rst file
+    # beside each source file named containing source file with
+    #
+    #    src/path.rst:
+    #
+    #    .. {{ path.replace('/','_') }}:
+    #
+    #    .. literalinclude:: {{ src/path }}
+    #        :language: {{ "python" if path.endswith('.py') else "c" }}
+    #        :linenos:
+    #
+    # and link to it using
+    #
+    #     colors = [":ref:`%s`"%(path.replace('/','_')) for path in sources]
+    #
+    # Probably need to dump all the rst files into an index.rst to build them.
+
+    # 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 = "\n$\\ \\star\\ $ "  # 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 +208 @@
     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
-
-    open(sys.argv[2],'w').write(docstr)
+        docstr += insertion
+
+    open(sys.argv[2], 'w').write(docstr)
 
 def process_model(path):