diff --git a/Internship_Diary/main.tex b/Internship_Diary/main.tex index 106fbeabf7f06e855999047ca5dbdedb1697e1c4..5477934a42eedb52b211b198ac87dfafa339fc26 100644 --- a/Internship_Diary/main.tex +++ b/Internship_Diary/main.tex @@ -241,5 +241,11 @@ Solution: This warning occured despite cython\_ext not being included. This occurred due to human error - I removed the 'x' from the '.pyx' when calling the exclude path in apidocs. Adding this solved the issue. +\subsection{Hosting} + +At this point the documentation render correctly on a local machine. To set set up hosting, first create a readthedocs (RTD) account import the project. The repository in question must be set to 'public' - this can be configured in the settings on gitlab. +Building documentation at this stage correctly creates most of the pages but not the module index - unusual because no errors occur on the build process. + + \end{document} diff --git a/docs/conf.py b/docs/conf.py index 81ddb6fa0d18b38914d804cc81a1b5c53b51de06..abe5a4e2aaad1233121852b5c500980792cd188b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,14 +33,14 @@ sys.path.insert(0, os.path.abspath('..')) # 'matplotlib.backends.backend_qt5agg.FigureCanvasQTAgg'] #sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) -autodoc_mock_imports = ['numpy', 'scipy', 'matplotlib', 'vtk', 'vtk.util', - 'PyQt5.QtCore', 'PyQt5.QtGui', 'Cython.Build.cythonize', - 'PyQt5.Widgets', 'scipy.optimize', 'vtk.qt', - 'mpl_toolkits.mplot3d', 'distutils.core.setup', 'struct', - 'numpy.linalg', 'vtk.qt.QVTKRenderWindowInteractor', 'pandas', - 'copy', 'scipy.spatial', 'scipy.special', 'scipy.interpolate', - 'matplotlib.figure', - 'matplotlib.backends.backend_qt5agg.FigureCanvasQTAgg'] +#autodoc_mock_imports = ['numpy', 'scipy', 'matplotlib', 'vtk', 'vtk.util', +# 'PyQt5.QtCore', 'PyQt5.QtGui', 'Cython.Build.cythonize', +# 'PyQt5.Widgets', 'scipy.optimize', 'vtk.qt', +# 'mpl_toolkits.mplot3d', 'distutils.core.setup', 'struct', +# 'numpy.linalg', 'vtk.qt.QVTKRenderWindowInteractor', 'pandas', +# 'copy', 'scipy.spatial', 'scipy.special', 'scipy.interpolate', +# 'matplotlib.figure', +# 'matplotlib.backends.backend_qt5agg.FigureCanvasQTAgg'] # -- Project information -----------------------------------------------------