Added basic docs

Using sphinx.
sidchaini · Feb 7, 2024 · 4103966 · 4103966
1 parent fc6945b
commit 4103966
Show file tree

Hide file tree

Showing 37 changed files with 5,295 additions and 0 deletions.
diff --git a/distclassipy/__pycache__/__init__.cpython-312.pyc b/distclassipy/__pycache__/__init__.cpython-312.pyc
diff --git a/distclassipy/__pycache__/classifier.cpython-312.pyc b/distclassipy/__pycache__/classifier.cpython-312.pyc
diff --git a/distclassipy/__pycache__/distances.cpython-312.pyc b/distclassipy/__pycache__/distances.cpython-312.pyc
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_build/doctrees/classifier.doctree b/docs/_build/doctrees/classifier.doctree
diff --git a/docs/_build/doctrees/distances.doctree b/docs/_build/doctrees/distances.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: af7b37c052b5b5b8f96e36de84367bad
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/classifier.rst.txt b/docs/_build/html/_sources/classifier.rst.txt
@@ -0,0 +1,7 @@
+DistanceMetricClassifier module
+===============================
+
+.. automodule:: distclassipy.classifier
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_build/html/_sources/distances.rst.txt b/docs/_build/html/_sources/distances.rst.txt
@@ -0,0 +1,7 @@
+Distance module
+===============
+
+.. automodule:: distclassipy.distances
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,63 @@
+.. DistClassiPy documentation master file, created by
+   sphinx-quickstart on Wed Feb  7 16:42:22 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to DistClassiPy's documentation!
+========================================
+
+DistClassiPy is a Python package for a distance-based classifier which can use several different distance metrics.
+
+Installation
+------------
+
+To install DistClassiPy, run the following command:
+
+.. code-block:: bash
+
+    pip install distclassipy
+
+Usage
+-----
+
+Here's a quick example to get you started with DistClassiPy:
+
+.. code-block:: python
+
+    import distclassipy as dcpy
+    clf = dcpy.DistanceMetricClassifier()
+    # Add your data and labels
+    clf.fit(data, labels)
+    # Predict new instances
+    predictions = clf.predict(new_data)
+
+Features
+--------
+
+- Multiple distance metrics support
+- Easy integration with existing data processing pipelines
+- Efficient and scalable for large datasets
+
+Contact
+-------
+
+For any queries, please reach out to Siddharth Chaini at [email protected].
+
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+API Documentation
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Reference
+
+   classifier
+   distances