Merge pull request #32 from dilyabareeva/docs

Initialize Sphinx Docs

docs/api.rst

@@ -0,0 +1,8 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   src

docs/conf.py

@@ -0,0 +1,32 @@
+# 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 = "data_attribution_evaluation"
+copyright = "2024, Dilya, Galip"
+author = "Dilya, Galip"
+release = "01.01.2050"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+]
+autosummary_generate = True  # Turn on sphinx.ext.autosummary
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- 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"]

docs/index.rst

@@ -0,0 +1,17 @@
+.. data_attribution_evaluation documentation master file, created by
+   sphinx-quickstart on Fri May 31 19:16:09 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to data_attribution_evaluation's documentation!
+=======================================================
+
+Check out the :doc:`usage` section for further information.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api

docs/usage.rst

@@ -0,0 +1,11 @@
+Usage
+=====
+
+Installation
+------------
+
+To use data_attribution_evaluation, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install data_attribution_evaluation