Changeset 1f5f206 in sasview

Timestamp:

Jul 26, 2015 4:58:27 PM (9 years ago)

Author:

butler

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:

fb3f9af

Parents:

e0c16ce

Message:

Fix sphinx compile errors with autogenerated model files. Was including
the path in doc string which for windows uses a slash which ReST
interprets as an escape charater. Was not rendering the source file
correctly for ANY of the generated but was a particular problem for
files that had an f as \f is formfeed.

Location:

src/sas/models/c_extension/python_wrapper

Files:

• WrapperGenerator.py (modified) (2 diffs)
• modelTemplate.txt (modified) (8 diffs)

src/sas/models/c_extension/python_wrapper/WrapperGenerator.py

@@ -560 +560 @@
     def replaceToken(self, line, key, value): #pylint: disable-msg=R0201
         """ Replace a token in the template file 
-            @param line: line of text to inspect
-            @param key: token to look for
-            @param value: string value to replace the token with
-            @return: new string value
+            :param line: line of text to inspect
+            :param key: token to look for
+            :param value: string value to replace the token with
+            :return: new string value
         """
+        _str_value = str(value)
+        _new_value = _str_value.replace('\\','/')
         lenkey = len(key)
         newline = line
@@ -570 +572 @@
         while newline.count(key) > 0:
             index = newline.index(key)
-            newline = newline[:index] + value + newline[index + lenkey:]
+            newline = newline[:index] + _new_value + newline[index + lenkey:]
 
         return newline

src/sas/models/c_extension/python_wrapper/modelTemplate.txt

@@ -17 +17 @@
 
 .. WARNING::
-
    THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
    DO NOT MODIFY THIS FILE, MODIFY
@@ -30 +29 @@
 def create_[PYTHONCLASS]():
     """
-       Create a model instance
+    Create a model instance
     """
     obj = [PYTHONCLASS]()
@@ -100 +99 @@
         """
         Evaluate the model
+
         :param x: input q, or [q,phi]
         :return: scattering function P(q)
@@ -108 +108 @@
         """
         Evaluate the model in cartesian coordinates
+
         :param x: input q, or [qx, qy]
         :return: scattering function P(q)
@@ -116 +117 @@
         """
         Evaluate the model in cartesian coordinates
+
         :param x: input q[], or [qx[], qy[]]
         :return: scattering function P(q[])
@@ -124 +126 @@
         """
         Calculate the effective radius for P(q)*S(q)
+
         :return: the value of the effective radius
         """
@@ -131 +134 @@
         """
         Calculate the volf ratio for P(q)*S(q)
+
         :return: the value of the volf ratio
         """
@@ -138 +142 @@
         """
         Set the dispersion object for a model parameter
+
         :param parameter: name of the parameter [string]
         :param dispersion: dispersion object of type DispersionModel