diff --git a/Internship_Diary/main.tex b/Internship_Diary/main.tex index e43d5792f92a73d01f7affe51c7564f467c4dc47..289a0843511eda1ffecc367f8f0b108e39f95bfe 100644 --- a/Internship_Diary/main.tex +++ b/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... diff --git a/docs/conf.py b/docs/conf.py index a165a24d28337e78a433d77c79bdd69f7393c7cb..0b422cab3d9861ab85321077493c67ad399c6c9e 100644 --- a/docs/conf.py +++ b/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. diff --git a/docs/source/AmpScan.rst b/docs/source/AmpScan.rst index ff30368ab2655207f75f9e5f6bab427250cdf807..f7c623e8abd2e0054ab844175b8951a35365670c 100644 --- a/docs/source/AmpScan.rst +++ b/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 -------------------------