docs added

mpecchi · May 12, 2024 · 4acc9ee · 4acc9ee
1 parent 0c013ad
commit 4acc9ee
Show file tree

Hide file tree

Showing 8 changed files with 87 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -226,3 +226,5 @@ $RECYCLE.BIN/
 
 src/.DS_Store
 .DS_Store
+docs/make.bat
+docs/Makefile
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/README.md b/docs/source/README.md
@@ -0,0 +1 @@
+../../README.md
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,37 @@
+# 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
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "hplc_data_analysis"
+copyright = "2024, Matteo Pecchi"
+author = "Matteo Pecchi"
+release = "v2.0.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.viewcode",
+    "myst_parser",
+    "sphinx.ext.napoleon",
+]
+
+
+exclude_patterns = []
+
+templates_path = ["_templates"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+
+html_static_path = ["_static"]
+autoclass_content = "both"
diff --git a/docs/source/fragmenter.rst b/docs/source/fragmenter.rst
@@ -0,0 +1,7 @@
+hplc_data_analysis.fragmenter
+====================================
+
+.. automodule:: hplc_data_analysis.fragmenter
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/hplc.rst b/docs/source/hplc.rst
@@ -0,0 +1,7 @@
+hplc_data_analysis.hplc
+====================================
+
+.. automodule:: hplc_data_analysis.hplc
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,26 @@
+.. hplc_data_analysis documentation master file, created by
+   sphinx-quickstart on Sun May 12 17:59:27 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to hplc_data_analysis's documentation!
+==============================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   README.md
+
+   hplc
+
+   fragmenter
+
+   pubchem
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/pubchem.rst b/docs/source/pubchem.rst
@@ -0,0 +1,7 @@
+hplc_data_analysis.pubchem
+====================================
+
+.. automodule:: hplc_data_analysis.pubchem
+   :members:
+   :undoc-members:
+   :show-inheritance: