Changeset c22c5e3 in sasview for docs/sphinx-docs

Timestamp:

May 8, 2015 2:15:19 PM (10 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, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

ac7be54

Parents:

c23de6a

Message:

copy bumps optimizer docs into sasview docs, if available

File:

• docs/sphinx-docs/build_sphinx.py (modified) (4 diffs)

docs/sphinx-docs/build_sphinx.py

@@ -11 +11 @@
 import shutil
 import imp
+from glob import glob
 
 from distutils.dir_util import copy_tree
@@ -32 +33 @@
 SPHINX_SOURCE_MODELS = os.path.join(SPHINX_SOURCE, "user", "models")
 SPHINX_SOURCE_PERSPECTIVES = os.path.join(SPHINX_SOURCE, "user", "perspectives")
+
+BUMPS_DOCS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..",
+                          "bumps", "doc", "guide")
+BUMPS_TARGET = os.path.join(SPHINX_SOURCE_PERSPECTIVES, "fitting")
 
 def _remove_dir(dir_path):
@@ -82 +87 @@
             copy_tree(docs, dest_dir)
 
+def retrieve_bumps_docs():
+    """
+    Copies select files from the bumps documentation into fitting perspective
+    """
+    if os.path.exists(BUMPS_DOCS):
+        print "=== Retrieve BUMPS Docs ==="
+        filenames = [os.path.join(BUMPS_DOCS, "optimizer.rst")]
+        filenames += glob(os.path.join(BUMPS_DOCS, "dream-*.png"))
+        filenames += glob(os.path.join(BUMPS_DOCS, "fit-*.png"))
+        for f in filenames:
+            print "Copying file", f
+            shutil.copy(f, BUMPS_TARGET)
+    else:
+        print """
+*** Error *** missing directory %s
+The documentation will not include the optimizer selection section.
+Checkout the bumps source tree and rebuild the docs.
+
+
+""" % BUMPS_DOCS
+
 def apidoc():
     """
@@ -115 +141 @@
     clean()
     retrieve_user_docs()
+    retrieve_bumps_docs()
     apidoc()
     build()