Changeset 2387abc in sasview for docs

Timestamp:

Aug 19, 2016 11:02:55 AM (8 years ago)

Author:

lewis

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

Children:

6f343e3

Parents:

32c5983 (diff), 45d7662 (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.

Message:

Merge branch 'master' into corfunc

Location:

docs/sphinx-docs

Files:

• build_sphinx.py (modified) (6 diffs)
• source/user/analysis.rst (modified) (1 diff)
• source/user/sasgui/perspectives/corfunc/corfunc_help.rst (added)
• source/user/sasgui/perspectives/corfunc/fig1.gif (added)
• source/user/sasgui/perspectives/corfunc/fig2.gif (added)
• source/user/sasgui/perspectives/corfunc/tutorial1.png (added)
• source/user/sasgui/perspectives/corfunc/tutorial2.png (added)
• source/user/sasgui/perspectives/corfunc/tutorial3.png (added)

docs/sphinx-docs/build_sphinx.py

@@ -35 +35 @@
 #/sasview-local-trunk/docs/sphinx-docs/build_sphinx.py
 SASMODELS_SOURCE_PROLOG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc")
+SASMODELS_SOURCE_MAGNETISM = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "magnetism")
+SASMODELS_SOURCE_MAGIMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "magnetism", "mag_img")
 SASMODELS_SOURCE_REF_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "models")
 SASMODELS_SOURCE_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "model")
@@ -43 +45 @@
 SASMODELS_DEST_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "source", "user", "models")
 SASMODELS_DEST_IMG = os.path.join(CURRENT_SCRIPT_DIR,  "source", "user", "model-imgs", "new-models")
+SASMODELS_DEST_MAGIMG = os.path.join(CURRENT_SCRIPT_DIR,  "source", "user", "mag_img")
 SASMODELS_DEST_BUILDIMG = os.path.join(CURRENT_SCRIPT_DIR,  "source", "user", "models", "img")
 
@@ -136 +139 @@
 
             copy_tree(docs, dest_dir)
-            
+
     # Now pickup testdata_help.rst
 #    print os.path.abspath(SASVIEW_TEST)
@@ -143 +146 @@
     if os.path.exists(SASVIEW_TEST):
        print "Found docs folder at ", SASVIEW_TEST
-       shutil.copytree(SASVIEW_TEST, SPHINX_SOURCE_TEST)       
-
-    print "=== And the Sasmodels Docs ===" 
+       shutil.copytree(SASVIEW_TEST, SPHINX_SOURCE_TEST)
+
+    print "=== And the Sasmodels Docs ==="
     # Make sure we have the relevant images for the new sasmodels documentation
     # First(!) we'll make a local reference copy for SasView (/new-models will be cleaned each build)
@@ -174 +177 @@
             shutil.copy(fromhere,tohere)
         else: print "no source directorty",SASMODELS_SOURCE_AUTOIMG ,"was found"
-    
+
     # And the rst prolog with the unit substitutions
     if os.path.exists(SASMODELS_SOURCE_PROLOG):
@@ -186 +189 @@
                     tohere=os.path.join(SASMODELS_DEST_PROLOG,files)
                     shutil.copy(fromhere,tohere)
+
+    if os.path.exists(SASMODELS_SOURCE_MAGNETISM):
+        print "Found docs folder SASMODELS_SOURCE_MAGNETISM at ", SASMODELS_SOURCE_MAGNETISM
+        if os.path.exists(SASMODELS_DEST_REF_MODELS):
+            print "Found docs folder SASMODELS_DEST_REF_MODELS   at ", SASMODELS_DEST_REF_MODELS
+            print "Copying sasmodels model toctree files..."
+            for files in os.listdir(SASMODELS_SOURCE_MAGNETISM):
+                if files.endswith(".rst"):
+                    fromhere=os.path.join(SASMODELS_SOURCE_MAGNETISM,files)
+                    tohere=os.path.join(SASMODELS_DEST_REF_MODELS,files)
+                    shutil.copy(fromhere,tohere)
+
+    if os.path.exists(SASMODELS_SOURCE_MAGIMG):
+        print "Found img  folder SASMODELS_SOURCE_MAGIMG    at ", SASMODELS_SOURCE_MAGIMG
+        if not os.path.exists(SASMODELS_DEST_MAGIMG):
+            print "Missing docs folder SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG
+            os.makedirs(SASMODELS_DEST_MAGIMG)
+            print "created SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG
+        print "Copying sasmodels model auto-generated image files..."
+        for files in os.listdir(SASMODELS_SOURCE_MAGIMG):
+            fromhere=os.path.join(SASMODELS_SOURCE_MAGIMG,files)
+            tohere=os.path.join(SASMODELS_DEST_MAGIMG,files)
+            shutil.copy(fromhere,tohere)
+        else: print "no source directorty",SASMODELS_SOURCE_MAGIMG ,"was found"
 
     if os.path.exists(SASMODELS_SOURCE_REF_MODELS):

docs/sphinx-docs/source/user/analysis.rst

@@ -6 +6 @@
 .. toctree::
    :maxdepth: 1
-   
+
    Model Fitting <sasgui/perspectives/fitting/fitting>
-   
+
    P(r) Inversion <sasgui/perspectives/pr/pr_help>
-   
+
    Invariant Calculation <sasgui/perspectives/invariant/invariant_help>
+
+   Correlation Function <sasgui/perspectives/corfunc/corfunc_help>