Merge branch 'Autodocs_script' into 'master'

retweaked align.py

See merge request !2

AmpScan/align.py

@@ -11,19 +11,6 @@ from scipy.optimize import minimize
 
 
 def align(moving, static, method = 'P2P'):
-    
-
-    def icp():
-        """
-        Automated alignment function between two meshes
-        """
-        tTree = spatial.cKDTree(self.baseline.vert)
-        rot = np.array([0,0,0], dtype=float)
-        res = minimize(self.calcDistError, rot, method='BFGS',
-                       options={'gtol':1e-6, 'disp':True})
-        
-        
-    def calcDistError(rot, tTree):
     """
     Using this function for sample docstring (one line desc).
 
@@ -31,11 +18,13 @@ def align(moving, static, method = 'P2P'):
 
     Parameters
     ----------
-        rot : array_like
+    moving : array_like
         Rot has a structure that can be iterated through implying it should be an
         array like structure
-        tTree : data_type
+    static : data_type
         Description of tTree input and what it does.
+    method : data_type
+        Desc of method
 
     Returns
     -------
@@ -102,6 +91,18 @@ def align(moving, static, method = 'P2P'):
     b
 
     """    
+
+    def icp():
+        """
+        Automated alignment function between two meshes
+        """
+        tTree = spatial.cKDTree(self.baseline.vert)
+        rot = np.array([0,0,0], dtype=float)
+        res = minimize(self.calcDistError, rot, method='BFGS',
+                       options={'gtol':1e-6, 'disp':True})
+        
+        
+    def calcDistError(rot, tTree):
         Id = np.identity(3)
         for i in range(3):
             if rot[i] != 0:

AmpScan/docstringstuff.py

+# -*- coding: utf-8 -*-
+"""
+Created on Thu July 05 11:10:30 2018
+
+@author: ojs1g14
+"""
+
+
+def add_docs(input_file):
+    """
+    docstring yo
+    """
+    f = open(input_file, r+)
+    for line in f.readlines():
+        if "def " in line:
+            print(str(line))
+    
+    f.close()
\ No newline at end of file

Internship_Diary/main.tex

@@ -135,5 +135,17 @@ pip install numpydoc
 
 An example docstring is provided in the inline documentation - I added this to the \_doctemplates folder in the top level directory with some tweaks to make it more relevant to the project. Copyright infringement may be worth considering before future deployment.
 
+\noindent\fbox{%
+    \parbox{\textwidth}{%
+        Quick Note on Git:
+
+I spent some time finding that I could not add changes made to my branch. Changes were listed but would not be staged when I used \lstinline{git add .}. This turned out to be because I was not in the root directory of the branch.
+    }%
+}
+
+...
+
+\subsection{Gitlab Wiki}
+Gitlab provides in built documentation associated with the project...
 
 \end{document}