Merge branch 'sorting_analyse.py_docs' into 'master'

switched to napoleon style docs

See merge request !9

AmpScan/analyse.py

@@ -14,8 +14,16 @@ from collections import defaultdict
 
 
 class analyseMixin(object):
+    """
+    Desc needed.
+
+    """
 
     def plot_slices(self, axis='Z', slWidth=10, stype=0):
+        """
+        method desc needed
+
+        """
         # Find the brim edges 
         ind = np.where(self.faceEdges[:,1] == -99999)
         # Define max Z from lowest point on brim
@@ -65,6 +73,10 @@ class analyseMixin(object):
         
     @staticmethod
     def create_slices(self, slices, axis='Z'):
+        """
+        static method desc needed.
+
+        """
         vE = self.vert[:,2][self.edges]
         # Find all vertices below plane 
         polys = []
@@ -112,6 +124,18 @@ class analyseMixin(object):
         return polys
     
     def create_slices_cy(self, slices, axis='Z'):
+        """
+        Another method desc.
+        
+        Attributes
+        ----------
+        
+        slices : array
+            Probably not array
+        axis : arg
+            defaults to Z
+
+        """
         vE = self.vert[:,2][self.edges]
         # Find all vertices below plane 
         polys = []

Internship_Diary/main.tex

@@ -203,6 +203,19 @@ WARNING: html_static_path entry 'C:\\Users\\Oliver\\Documents\\Internship-1718\\
 
 Solution:
 
-A \_static file containing css templates does exist in docs\\\_build\\html but sphinx looks for it in docs. I copied the file to this location and the error went away.
+A \_static file containing css templates does exist in docs\_build\\html but sphinx looks for it in docs. I copied the file to this location and the error went away.
+
+Tracback 4:
+
+\begin{lstlisting}[language=Python]
+WARNING: toctree references unknown document 'source/AmpScan.analyse.analyseMixin.create_slices
+\end{lstlisting}
+
+9 warnings of this type were generated.
+
+Solution:
+
+'numpydoc' was removed from the extension list and replaced with 'sphinx.ext.napoleon'.
+
 
 \end{document}

docs/conf.py

@@ -41,7 +41,7 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.githubpages',
-    'numpydoc',
+    'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
 ]
 

docs/source/AmpScan.rst

@@ -12,18 +12,10 @@ AmpScan.align module
     :undoc-members:
     :show-inheritance:
 
-AmpScan.test\_file module
--------------------------
+AmpScan.analyse module
+----------------------
 
-.. automodule:: AmpScan.test_file
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-AmpScan.test\_file\_2 module
-----------------------------
-
-.. automodule:: AmpScan.test_file_2
+.. automodule:: AmpScan.analyse
     :members:
     :undoc-members:
     :show-inheritance:

[ojs1g14]

USE THIS COMMIT AS WAYPOINT 1: -ALIGN.PY RENDERS -ANALYSE.PY RENDERS