debezium/dbz#2198 docs: initialize Sphinx framework and API reference…

[KMohnishM]

… docs

Description

This Pull Request implements the first half of GSoC Week 7 targets under tracking issue debezium/dbz#2198. It establishes a clean, python-standard Sphinx documentation structure inside the docs/ directory, configures automated API documentation extraction extensions, and resolves duplicate object definition warnings.

Key Changes

1. Dependency Configuration:
   • Registered the docs optional dependency group inside pyproject.toml (containing sphinx and sphinx_rtd_theme).
2. Sphinx Setup:
   • Initialized docs/conf.py pointing project metadata to pydebeziumai.
   • Enabled and configured autodoc extensions (sphinx.ext.autodoc, sphinx.ext.napoleon, sphinx.ext.viewcode, sphinx.ext.intersphinx).
   • Added standard UNIX/Windows Makefiles (docs/Makefile and docs/make.bat).
3. API Reference Indexing:
   • Added index.rst landing master TOC.
   • Generated modular API reference pages automatically from inline docstrings for:
     • pydebeziumai.ingestion
     • pydebeziumai.transformation
     • pydebeziumai.sync.manager
     • pydebeziumai.adapters (Chroma, PGVector, Milvus)
     • pydebeziumai.retrieval.langgraph
4. Code Quality and Docstring Refinements:
   • Corrected docstring indentation inside pydebeziumai/ingestion/connect_handler.py to fix docutils parser warnings.
   • Configured napoleon_use_ivar=True in conf.py to prevent duplicate attribute indexing warnings for dataclasses.

Verification Results

• Sphinx Doc Generation: Build completed successfully with 0 warnings and 0 errors.
• Ruff Quality Check: Passed (All checks passed!).
• MyPy Type Safety: Passed (Success: no issues found in 40 source files).
• Test Suite: Run and passed 86 tests successfully.