[add:docs] Init documentation for "Read The Docs"

Author: Qu1nel

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/how_it_works/index.md

@@ -0,0 +1 @@
+sdfsdf

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/api_reference/cli.rst

@@ -0,0 +1,9 @@
+.. _api_cli:
+
+Command-Line Interface
+======================
+
+.. automodule:: code_validator.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_reference/components.rst

@@ -0,0 +1,24 @@
+.. _api_components:
+
+Component Architecture
+======================
+
+This section documents the core architectural components, such as protocols
+and factories.
+
+.. rubric:: Component Interfaces
+
+.. automodule:: code_validator.components.definitions
+   :members:
+
+.. rubric:: Component Factories
+
+.. automodule:: code_validator.components.factories
+   :members:
+
+.. rubric:: Helper Modules
+
+.. automodule:: code_validator.components.scope_handler
+   :members:
+.. automodule:: code_validator.components.ast_utils
+   :members:

docs/source/api_reference/config.rst

@@ -0,0 +1,9 @@
+.. _api_config:
+
+Configuration Models
+====================
+
+.. automodule:: code_validator.config
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_reference/core.rst

@@ -0,0 +1,9 @@
+.. _api_core:
+
+Core Validator Engine
+=====================
+
+.. automodule:: code_validator.core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_reference/exceptions.rst

@@ -0,0 +1,9 @@
+.. _api_exceptions:
+
+Custom Exceptions
+=================
+
+.. automodule:: code_validator.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api_reference/index.rst

@@ -0,0 +1,30 @@
+.. _api_reference:
+
+*************
+API Reference
+*************
+
+This section provides auto-generated documentation from the source code's
+docstrings. It details the classes, methods, and functions available for
+programmatic use or for extending the validator.
+
+This reference is intended for developers who wish to understand the internal
+workings of the ``code-validator`` package or contribute to its development.
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Core Modules:
+
+   cli
+   core
+   config
+   output
+   exceptions
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Component Architecture:
+
+   components
+   rules_library

docs/source/api_reference/output.rst

@@ -0,0 +1,9 @@
+.. _api_output:
+
+Console & Logging
+=================
+
+.. automodule:: code_validator.output
+   :members:
+   :undoc-members:
+   :show-inheritance: