add documentation

Author: ashryaagr

.gitignore

@@ -2,6 +2,33 @@ env
 __pycache__
 *.csv
 *.env
-!.env
+!config/.env
 .DS_Store
-*.json
+*.json
+
+# Sphinx build directories
+_build/
+build/
+
+# Sphinx cache
+*.doctree
+*.pickle
+
+# Auto-generated API documentation (if using sphinx-apidoc)
+docs/source/modules.rst
+
+# Temporary or log files
+*.log
+*.tmp
+*.bak
+*.swp
+
+# Editor/IDE-specific files
+.vscode/
+.idea/
+__pycache__/
+*.py[cod]
+
+# Virtual environment
+venv/
+.env/

docs/README.md

@@ -0,0 +1,11 @@
+## Steps to build the documentation
+
+```bash
+cd docs
+virtualenv .env
+source .env/bin/activate
+pip install -r requirements.txt
+cd source
+# Might need to open a new terminal (with same python environment as above) before you can execute the command below.
+sphinx-build -b html . build # or can use make html
+```

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx-autoapi
+myst-parser

docs/source/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)

docs/source/conf.py

@@ -0,0 +1,48 @@
+# 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 = 'BreakYourLLM'
+copyright = '2024, ModelPulse'
+author = 'ModelPulse'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+extensions = [
+    'sphinx.ext.autodoc',     # Optional but not required with autoapi
+    'sphinx.ext.napoleon',    # For Google/NumPy-style docstrings
+    'myst_parser',            # For Markdown support
+    'autoapi.extension',      # Use autoapi
+]
+
+
+# -- 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']
+
+# myst_enable_extensions = [
+#     "colon_fence",   # Use ::: for block directives
+#     "linkify",       # Automatically detect links
+#     "substitution",  # Support text substitutions
+# ]
+
+master_doc = 'index'  # If still 'index.md', no changes needed
+
+# Point to your Python source code
+autoapi_dirs = ['../../sources']
+
+# Set the output format to MyST Markdown
+autoapi_keep_files = True  # Keep generated Markdown files
+
+myst_enable_extensions = ['amsmath', 'colon_fence']  

docs/source/index.md

@@ -0,0 +1,18 @@
+<!-- .. BreakYourLLM documentation master file, created by
+   sphinx-quickstart on Sat Dec  7 19:37:28 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive. -->
+
+BreakYourLLM documentation
+==========================
+
+<!-- Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details. -->
+
+
+```{toctree}
+:maxdepth: 2
+:caption: API Documentation:
+
+autoapi/index

docs/source/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd