Changeset 7d6f1bd in sasview for docs

Timestamp:

Apr 5, 2014 9:24:06 AM (11 years ago)

Author:

Peter Parker

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:

30fbe6d

Parents:

f330d67

Message:

Refs #202 - Copy built docs to SasView? build folder.

File:

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

docs/sphinx-docs/build_sphinx.py

@@ -20 +20 @@
 SASVIEW_SRC = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "src")
 SASVIEW_BUILD = os.path.abspath(os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "build", "lib"+platform))
+SASVIEW_DOCS = os.path.join(SASVIEW_BUILD, "doc")
 
 SPHINX_BUILD = os.path.join(CURRENT_SCRIPT_DIR, "build")
 SPHINX_SOURCE = os.path.join(CURRENT_SCRIPT_DIR, "source")
-SPHINX_SOURCE_API = os.path.join(SPHINX_SOURCE, "dev","api")
+SPHINX_SOURCE_API = os.path.join(SPHINX_SOURCE, "dev", "api")
 
 def _remove_dir(dir_path):
@@ -40 +41 @@
 def retrieve_user_docs():
     """
-    Copies across the contents of any docs/ directories in src/, and puts them
+    Copies across the contents of any media/ directories in src/, and puts them
     in an appropriately named directory of docs/sphinx-docs/source/. For
     example:
 
-    sans/../[MODULE]/docs/A.rst
-    sans/../[MODULE]/docs/B.rst
+        sans/../[MODULE]/media/dir/A.rst
+        sans/../[MODULE]/media/B.rst
 
     gets copied to a new location:
 
-    docs/sphinx-docs/source/user/[MODULE]/A.rst
-    docs/sphinx-docs/source/user/[MODULE]/B.rst
+        docs/sphinx-docs/source/user/[MODULE]/dir/A.rst
+        docs/sphinx-docs/source/user/[MODULE]/B.rst
 
     so that Sphinx may pick it up when generating the documentation.
@@ -58 +59 @@
     # Copy documentation files from their "source" to their "destination".
     for root, dirnames, _ in os.walk(SASVIEW_SRC):
-        for dirname in fnmatch.filter(dirnames, 'docs'):
+        for dirname in fnmatch.filter(dirnames, 'media'):
 
             docs = os.path.abspath(os.path.join(root, dirname))
@@ -66 +67 @@
             dest_dir = os.path.join(SPHINX_SOURCE, "user", dest_dir_name)
 
-            copy_tree(docs, dest_dir, update=1)
+            copy_tree(docs, dest_dir)
 
 def apidoc():
@@ -87 +88 @@
     Runs sphinx-build.  Reads in all .rst files and spits out the final html.
     """
-    print "=== Build HTML from Rest Files ==="
+    print "=== Build HTML Docs from Rest Files ==="
     subprocess.call(["sphinx-build",
-                     "-b", "html", # Builder name.
-                     "-d", os.path.join(SPHINX_BUILD, "doctrees"), # Cache directory (doctrees).
+                     "-b", "html", # Builder name. TODO: accept as arg to setup.py.
+                     "-d", os.path.join(SPHINX_BUILD, "doctrees"),
                      SPHINX_SOURCE,
                      os.path.join(SPHINX_BUILD, "html")])
 
+    print "=== Copy HTML Docs to Build Directory ==="
+    html = os.path.join(SPHINX_BUILD, "html")
+    copy_tree(html, SASVIEW_DOCS)
+
 if __name__ == "__main__":
     call()