add the docs

docs/API.rst

@@ -0,0 +1,6 @@
+API
+=========================================
+.. toctree::
+    :maxdepth: 3
+    
+    analyser.rst

docs/analyser.rst

@@ -0,0 +1,17 @@
+Analyser
+---------------------
+
+Imaging Analyser
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. automodule:: Analyser.ImagingAnalyser
+      :members:
+
+Fit Analyser
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. automodule:: Analyser.FitAnalyser
+   :members:
+
+FFT Analyser
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. automodule:: Analyser.FFTAnalyser
+   :members:

docs/conf.py

@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Set path -----------------------------------------------------
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'DyLabDataCruncher'
+copyright = '2023, Jianshun Gao'
+author = 'Jianshun Gao'
+release = '0.5'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon',
+              'nbsphinx']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+autodoc_mock_imports = ['scipy', 'pandas']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
+
+html_theme = 'sphinx_rtd_theme'

docs/index.rst

@@ -0,0 +1,19 @@
+.. analyseScript documentation master file, created by
+   sphinx-quickstart on Wed Jul  5 16:50:19 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to DyLab Data Cruncher's documentation!
+=========================================
+
+.. toctree::
+   :maxdepth: 2
+
+   API.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`