Changeset 5dd7499 in sasview for docs

Timestamp:

Oct 6, 2016 7:07:24 PM (8 years ago)

Author:

ajj

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:

b61bd57

Parents:

2a07053

Message:

Fixing sphinx build to assemble documents out of source tree to avoid pollution

File:

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

docs/sphinx-docs/build_sphinx.py

@@ -30 +30 @@
 SASVIEW_DOCS = os.path.join(SASVIEW_BUILD, "doc")
 SASVIEW_TEST = os.path.join(SASVIEW_SRC, "..", "sasview", "test", "media")
+SASVIEW_TOC_SOURCE = os.path.join(CURRENT_SCRIPT_DIR, "source")
 
 # Need to slurp in the new sasmodels model definitions to replace the old model_functions.rst
@@ -42 +43 @@
 SASMODELS_SOURCE_IMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "model", "img")
 SASMODELS_SOURCE_AUTOIMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "_build", "html","_images")
-SASMODELS_DEST_PROLOG = os.path.join(CURRENT_SCRIPT_DIR, "source")
-SASMODELS_DEST_REF_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "source", "user")
-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")
+## Don't do assemble-in-place
+## Assemble the docs in a temporary folder
+SASMODELS_DEST_PROLOG = os.path.join(CURRENT_SCRIPT_DIR, "source-temp")
+SASMODELS_DEST_REF_MODELS = os.path.join(SASMODELS_DEST_PROLOG, "user")
+SASMODELS_DEST_MODELS = os.path.join(SASMODELS_DEST_PROLOG, "user", "models")
+SASMODELS_DEST_IMG = os.path.join(SASMODELS_DEST_PROLOG, "user", "model-imgs", "new-models")
+SASMODELS_DEST_MAGIMG = os.path.join(SASMODELS_DEST_PROLOG, "user", "mag_img")
+SASMODELS_DEST_BUILDIMG = os.path.join(SASMODELS_DEST_PROLOG, "user", "models", "img")
 
 #if os.path.exists(SASMODELS_SOURCE_PROLOG):
@@ -66 +69 @@
 
 SPHINX_BUILD = os.path.join(CURRENT_SCRIPT_DIR, "build")
-SPHINX_SOURCE = os.path.join(CURRENT_SCRIPT_DIR, "source")
+SPHINX_SOURCE = os.path.join(CURRENT_SCRIPT_DIR, "source-temp")
 SPHINX_SOURCE_API = os.path.join(SPHINX_SOURCE, "dev", "api")
 SPHINX_SOURCE_GUIFRAME = os.path.join(SPHINX_SOURCE, "user", "sasgui", "guiframe")
@@ -104 +107 @@
     _remove_dir(SASVIEW_DOCS)
     _remove_dir(SPHINX_BUILD)
-    _remove_dir(SPHINX_SOURCE_GUIFRAME)
-    _remove_dir(SPHINX_SOURCE_MODELS)
-    _remove_dir(SPHINX_SOURCE_PERSPECTIVES)
-    _remove_dir(SPHINX_SOURCE_TEST)
-
+    _remove_dir(SPHINX_SOURCE)
+    #_remove_dir(SPHINX_SOURCE_GUIFRAME)
+    #_remove_dir(SPHINX_SOURCE_MODELS)
+    #_remove_dir(SPHINX_SOURCE_PERSPECTIVES)
+    #_remove_dir(SPHINX_SOURCE_TEST)
+
+def setup_source_temp():
+    """
+    Copy the source toctrees to new folder for assembling the sphinx-docs
+    """
+    print "=== Copying Source toctrees ==="
+    if os.path.exists(SASVIEW_TOC_SOURCE):
+       print "Found docs folder at ", SASVIEW_TOC_SOURCE
+       shutil.copytree(SASVIEW_TOC_SOURCE, SPHINX_SOURCE)
 
 def retrieve_user_docs():
@@ -336 +348 @@
 def rebuild():
     clean()
+    setup_source_temp()
     retrieve_user_docs()
     retrieve_bumps_docs()