From 655dd09b5ccf0002b14145091ff580eee3357059 Mon Sep 17 00:00:00 2001 From: Khushiyant Date: Sun, 3 Mar 2024 22:25:24 +0530 Subject: [PATCH] docs: add sphinx--module --- .gitignore | 1 + docs/conf.py | 23 ++++++----------- docs/index.rst | 10 ++++---- docs/modules.rst | 7 ++++++ docs/quasar.algorithm.rst | 29 +++++++++++++++++++++ docs/quasar.cli.rst | 10 ++++++++ docs/quasar.handler.rst | 21 ++++++++++++++++ docs/quasar.rst | 22 ++++++++++++++++ docs/quasar.tests.rst | 45 +++++++++++++++++++++++++++++++++ docs/quasar.utils.rst | 53 +++++++++++++++++++++++++++++++++++++++ 10 files changed, 200 insertions(+), 21 deletions(-) create mode 100644 docs/modules.rst create mode 100644 docs/quasar.algorithm.rst create mode 100644 docs/quasar.cli.rst create mode 100644 docs/quasar.handler.rst create mode 100644 docs/quasar.rst create mode 100644 docs/quasar.tests.rst create mode 100644 docs/quasar.utils.rst diff --git a/.gitignore b/.gitignore index e69541e..835c6cf 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ __pycache__/ # Distribution / packaging dist/ build/ +_build/ *.egg-info/ *.egg diff --git a/docs/conf.py b/docs/conf.py index 27f54a0..9d36a30 100644 --- a/docs/conf.py +++ b/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'] diff --git a/docs/index.rst b/docs/index.rst index a97cd1c..da8bd62 100644 --- a/docs/index.rst +++ b/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 ================== diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..3e0ff35 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +quasar +====== + +.. toctree:: + :maxdepth: 4 + + quasar diff --git a/docs/quasar.algorithm.rst b/docs/quasar.algorithm.rst new file mode 100644 index 0000000..c54447a --- /dev/null +++ b/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: diff --git a/docs/quasar.cli.rst b/docs/quasar.cli.rst new file mode 100644 index 0000000..b905d7d --- /dev/null +++ b/docs/quasar.cli.rst @@ -0,0 +1,10 @@ +quasar.cli package +================== + +Module contents +--------------- + +.. automodule:: quasar.cli + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/quasar.handler.rst b/docs/quasar.handler.rst new file mode 100644 index 0000000..c4baf61 --- /dev/null +++ b/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: diff --git a/docs/quasar.rst b/docs/quasar.rst new file mode 100644 index 0000000..d9502d6 --- /dev/null +++ b/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: diff --git a/docs/quasar.tests.rst b/docs/quasar.tests.rst new file mode 100644 index 0000000..25443bb --- /dev/null +++ b/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: diff --git a/docs/quasar.utils.rst b/docs/quasar.utils.rst new file mode 100644 index 0000000..bf27741 --- /dev/null +++ b/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: