docs: add sphinx--module

.gitignore

@@ -6,6 +6,7 @@ __pycache__/
 # Distribution / packaging
 dist/
 build/
+_build/
 *.egg-info/
 *.egg
 

docs/conf.py

@@ -1,28 +1,19 @@
-# 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
+import pathlib
+import sys
 
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
 
-project = 'quasar'
+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 = []
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.napoleon', 'sphinx.ext.viewcode']
 
 templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-
+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/index.rst

@@ -1,16 +1,16 @@
-.. quasar documentation master file, created by
-   sphinx-quickstart on Sun Mar  3 00:06:37 2024.
+.. Quasar Dosc documentation master file, created by
+   sphinx-quickstart on Sun Mar  3 22:17:24 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!
-==================================
+Welcome to Quasar Dosc's documentation!
+=======================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-
+   modules
 
 Indices and tables
 ==================

docs/modules.rst

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

docs/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.llm module
+---------------------------
+
+.. automodule:: quasar.algorithm.llm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: quasar.algorithm
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/quasar.cli.rst

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

docs/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/quasar.rst

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

docs/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/quasar.utils.rst

@@ -0,0 +1,53 @@
+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.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: