Merge branch 'Ampscan_gui_working_docs' into 'master'

No more GUIs in docs plus maths rendering added

See merge request !7

Internship_Diary/main.tex

@@ -143,7 +143,14 @@ I spent some time finding that I could not add changes made to my branch. Change
     }%
 }
 
-...
+\subsection{Autodocs 2}
+The documentation consistently rendered submodules called from within AmpScan modules (those relating to vtk and qt). This is a persistent issue with many modules but for the sake of simplification all those relating to the GUI were chosen to be excluded from apidocs. Sphinx provides an exclude pattern which I implemented as follows:
+
+\begin{lstlisting}[language=Python]
+sphinx-apidoc -f -o source ..\AmpScan C:\... ...\Ampscan\AmpScanGUI.py
+\end{lstlisting}
+
+Note that the exclusion pattern requires an absolute path. The -f option ensures that existing files are replaced.
 
 \subsection{Gitlab Wiki}
 Gitlab provides in built documentation associated with the project...

docs/conf.py

@@ -41,7 +41,8 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.githubpages',
-    'numpydoc'
+    'numpydoc',
+    'sphinx.ext.mathjax',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/AmpScan.rst

@@ -4,14 +4,6 @@ AmpScan package
 Submodules
 ----------
 
-AmpScan.AmpScanGUI module
--------------------------
-
-.. automodule:: AmpScan.AmpScanGUI
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 AmpScan.align module
 --------------------
 
@@ -100,30 +92,6 @@ AmpScan.smooth module
     :undoc-members:
     :show-inheritance:
 
-AmpScan.socketDesignGUI module
-------------------------------
-
-.. automodule:: AmpScan.socketDesignGUI
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-AmpScan.surrogateModelGUI module
---------------------------------
-
-.. automodule:: AmpScan.surrogateModelGUI
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-AmpScan.surrogateModelGUI\_2 module
------------------------------------
-
-.. automodule:: AmpScan.surrogateModelGUI_2
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 AmpScan.test\_file module
 -------------------------