Changeset 939 for trunk/GSASIIpath.py

Timestamp:

Jun 2, 2013 11:07:35 PM (12 years ago)

Author:

toby

Message:

fix & cleanup unit tests; add/change doc strings for sphinx; add all G2 py files to sphinx

File:

• trunk/GSASIIpath.py (modified) (7 diffs)

trunk/GSASIIpath.py ¶

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
-'''Routines for dealing with file locations, etc.
 '''
+*GSASIIpath: locations & updates*
+---------------------------------
+
+Routines for dealing with file locations, etc.
+
+Determines the location of the compiled (.pyd or .so) libraries.
+
+Interfaces with subversion (svn): 
+Determine the subversion release number by determining the highest version number
+where :func:`SetVersionNumber` is called (best done in every GSASII file).
+Other routines will update GSASII from the subversion server if svn can be
+found.
+'''
+
 import os
 import sys
@@ -41 +54 @@
 version = -1
 def SetVersionNumber(RevString):
-    '''RevString is something like "$Revision$" that is set by subversion when
-    the file is retrieved from subversion.
+    '''Set the subversion version number
+
+    :param str RevString: something like "$Revision$"
+      that is set by subversion when the file is retrieved from subversion.
+
+    Place ``GSASIIpath.SetVersionNumber("$Revision$")`` in every python
+    file.
     '''
     try:
@@ -52 +70 @@
         
 def GetVersionNumber():
+    '''Return the maximum version number seen in :func:`SetVersionNumber`
+    '''
     return version
 
@@ -59 +79 @@
     Searches the current path as well as subdirectory "svn" and
     "svn/bin" in the location of the GSASII source files.
-    returns None if svn is not found.
+
+    :returns: None if svn is not found.
     '''
     def is_exe(fpath):
@@ -77 +98 @@
     or contacts the subversion server to get the latest update version (# of Head).
 
-    parameters:
-     fpath: path to repository dictionary, defaults to directory where
+    :param fpath: path to repository dictionary, defaults to directory where
        the current file is located
-     local: determines the type of version number, where
+    :param local: determines the type of version number, where
        True (default): returns the latest installed update 
        False: returns the version number of Head on the server
 
-    Returns that number as an str.
-
-    Returns None if there is a subversion error (likely because the path is
+    :Returns: the version number as an str or 
+       None if there is a subversion error (likely because the path is
        not a repository or svn is not found)
     '''
@@ -114 +133 @@
        the list has length 0
 
-    parameter:
-     fpath: path to repository dictionary, defaults to directory where
+    :param fpath: path to repository dictionary, defaults to directory where
        the current file is located
 
-    Returns None if there is a subversion error (likely because the path is
+    :returns: None if there is a subversion error (likely because the path is
        not a repository or svn is not found)
+
     '''
     import subprocess
@@ -139 +158 @@
     '''This performs an update of the files in a local directory from a server. 
 
-    parameter:
-     fpath: path to repository dictionary, defaults to directory where
+    :param fpath: path to repository dictionary, defaults to directory where
        the current file is located
 
-    Returns:
-       A dictionary with the files that have been changed/added and
-          a code describing how they have been updated (see changetype)
-          
-       None if there is a subversion error (likely because the path is
+    :returns: A dictionary with the files that have been changed/added and
+          a code describing how they have been updated (see changetype) ro 
+          None if there is a subversion error (likely because the path is
           not a repository or svn is not found)
+
     '''
     import subprocess