docs: add sphinx--autodoc

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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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

docs/source/conf.py

@@ -0,0 +1,33 @@
+# 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
+
+import pathlib
+import sys
+
+sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
+
+project = 'Quasar'
+copyright = '2024, Khushiyant'
+author = 'Khushiyant'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- 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/source/index.rst

@@ -0,0 +1,20 @@
+.. Quasar documentation master file, created by
+   sphinx-quickstart on Tue Jan 30 15:08:34 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Quasar's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,8 @@
+quasar
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   quasar
+   setup

docs/source/quasar.algorithm.rst

@@ -0,0 +1,29 @@
+quasar.algorithm package
+========================
+
+Submodules
+----------
+
+quasar.algorithm.detector module
+--------------------------------
+
+.. automodule:: quasar.algorithm.detector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.algorithm.train module
+-----------------------------
+
+.. automodule:: quasar.algorithm.train
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quasar.algorithm
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quasar.cli.rst

@@ -0,0 +1,10 @@
+quasar.cli package
+==================
+
+Module contents
+---------------
+
+.. automodule:: quasar.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quasar.handler.rst

@@ -0,0 +1,21 @@
+quasar.handler package
+======================
+
+Submodules
+----------
+
+quasar.handler.issue module
+---------------------------
+
+.. automodule:: quasar.handler.issue
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quasar.handler
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quasar.rst

@@ -0,0 +1,33 @@
+quasar package
+==============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   quasar.algorithm
+   quasar.cli
+   quasar.handler
+   quasar.tests
+   quasar.utils
+
+Submodules
+----------
+
+quasar.types module
+-------------------
+
+.. automodule:: quasar.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quasar
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quasar.tests.rst

@@ -0,0 +1,45 @@
+quasar.tests package
+====================
+
+Submodules
+----------
+
+quasar.tests.conftest module
+----------------------------
+
+.. automodule:: quasar.tests.conftest
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.tests.test\_algorithm module
+-----------------------------------
+
+.. automodule:: quasar.tests.test_algorithm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.tests.test\_cli module
+-----------------------------
+
+.. automodule:: quasar.tests.test_cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.tests.test\_handler module
+---------------------------------
+
+.. automodule:: quasar.tests.test_handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quasar.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/quasar.utils.rst

@@ -0,0 +1,61 @@
+quasar.utils package
+====================
+
+Submodules
+----------
+
+quasar.utils.analyser module
+----------------------------
+
+.. automodule:: quasar.utils.analyser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.utils.ascii module
+-------------------------
+
+.. automodule:: quasar.utils.ascii
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.utils.data\_processor module
+-----------------------------------
+
+.. automodule:: quasar.utils.data_processor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.utils.formatter module
+-----------------------------
+
+.. automodule:: quasar.utils.formatter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.utils.logger module
+--------------------------
+
+.. automodule:: quasar.utils.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+quasar.utils.redis\_server module
+---------------------------------
+
+.. automodule:: quasar.utils.redis_server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quasar.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/setup.rst

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance: