diff --git a/AmpScan/analyse.py b/AmpScan/analyse.py index e554ffa2e92cb1a2ee3978ec4e02ed7a04c963ab..01d68823c2258d9efc841a9d7fbac9800e31fc97 100644 --- a/AmpScan/analyse.py +++ b/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 = [] diff --git a/Internship_Diary/main.tex b/Internship_Diary/main.tex index 3f64d4677ea6651caf80e3ea55d5bc278111c4a0..18a5b3697387359af2417c53c36761f59996cbbf 100644 --- a/Internship_Diary/main.tex +++ b/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} diff --git a/docs/conf.py b/docs/conf.py index 0b422cab3d9861ab85321077493c67ad399c6c9e..cd6a0f1720095d021ef95dbdfe5c9b0feec384d6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,7 +41,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.githubpages', - 'numpydoc', + 'sphinx.ext.napoleon', 'sphinx.ext.mathjax', ] diff --git a/docs/source/AmpScan.rst b/docs/source/AmpScan.rst index d9735af287a53ef05f59b9a549e4ae7c470ecb03..da1f0e4b48a84a72b35a5884f3322859ca307932 100644 --- a/docs/source/AmpScan.rst +++ b/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: