Changeset f4c0513 in sasview for docs/sphinx-docs

Timestamp:

Jun 29, 2015 4:13:16 PM (9 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:

60d08fd

Parents:

eddf6af5 (diff), 5a73356a (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' of github.com:sasview/sasview

Location:

docs/sphinx-docs

Files:

• build_sphinx.py (modified) (4 diffs)
• source/conf.py (modified) (2 diffs)
• source/index.rst (modified) (1 diff)
• source/test/testdata_help.rst (added)
• source/user/user.rst (modified) (2 diffs)
• source/_extensions/dollarmath.py (added)

docs/sphinx-docs/build_sphinx.py

@@ -27 +27 @@
 SASVIEW_BUILD = os.path.abspath(os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "build", "lib"+platform))
 SASVIEW_DOCS = os.path.join(SASVIEW_BUILD, "doc")
+SASVIEW_TEST = os.path.join(SASVIEW_SRC, "..", "sasview", "test", "media")
 
 SPHINX_BUILD = os.path.join(CURRENT_SCRIPT_DIR, "build")
@@ -34 +35 @@
 SPHINX_SOURCE_MODELS = os.path.join(SPHINX_SOURCE, "user", "models")
 SPHINX_SOURCE_PERSPECTIVES = os.path.join(SPHINX_SOURCE, "user", "perspectives")
+SPHINX_SOURCE_TEST = os.path.join(SPHINX_SOURCE, "test")
 
 BUMPS_DOCS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..",
@@ -55 +57 @@
     _remove_dir(SPHINX_SOURCE_MODELS)
     _remove_dir(SPHINX_SOURCE_PERSPECTIVES)
+    _remove_dir(SPHINX_SOURCE_TEST)
 
 def retrieve_user_docs():
@@ -87 +90 @@
 
             copy_tree(docs, dest_dir)
+            
+    # Now pickup testdata_help.rst
+#    print os.path.abspath(SASVIEW_TEST)
+#    print os.path.abspath(SPHINX_SOURCE_TEST)
+    if os.path.exists(SASVIEW_TEST):
+       print "Found docs folder at ", SASVIEW_TEST
+       shutil.copytree(SASVIEW_TEST, SPHINX_SOURCE_TEST)       
 
 def retrieve_bumps_docs():

docs/sphinx-docs/source/conf.py

@@ -53 +53 @@
 # General information about the project.
 project = u'SasView'
-copyright = u'2013, The SasView Project'
+copyright = u'2015, The SasView Project'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -60 +60 @@
 #
 # The short X.Y version.
-version = '3.0.0'
+version = '3.1.0'
 # The full version, including alpha/beta/rc tags.
-release = '3.0.0'
+release = '3.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation

docs/sphinx-docs/source/index.rst

@@ -4 +4 @@
    contain the root `toctree` directive.
 
-SasView Documentation
-=====================
+SasView Documentation Index
+===========================
 
 .. toctree::
    :maxdepth: 1
 
-   Model Documentation <user/models/model_functions>
-   
    User Documentation <user/user>
 

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

@@ -1 @@
-User Documentation
-==================
+SasView User Documentation
+==========================
+
+.. note:: In Windows use [Alt]-[Cursor left] to return to the previous page
 
 .. toctree::
@@ -37 +39 @@
    Python Shell Tool <perspectives/calculator/python_shell_help>
    
-   Test Data <test/testdata.rst>
+   Test Data <../test/testdata_help.rst>