Skip to content

Commit 9d3a01a

Browse files
vinod0mvinod0m
committed
docs: update code documentation for new modules
DOCUMENTATION UPDATES: - Added RST files for 6 new modules introduced in recent phases: * analyzers.rst - Quality analysis & benchmarking * conversation.rst - Conversational AI & context management * exploration.rst - Interactive document exploration * processors.rst - Document & text processors * qa.rst - Question-answering systems * synthesis.rst - Document synthesis & generation INDEX UPDATES: - Updated index.rst to include new modules in proper sections: * AI/ML Components: conversation, qa, synthesis * Data Processing: processors, analyzers, exploration - Updated overview.rst with comprehensive component list - Updated modules.rst with complete module listing (22 modules) ENHANCED FEATURES: - Added module overviews and key components for each new module - Documented relationships with existing architecture - Updated LLM provider list (added Ollama, Cerebras) - Enhanced component descriptions with new capabilities CI PIPELINE: - Existing python-docs.yml workflow automatically picks up new RST files - build-docs.sh script uses rglob to auto-discover all Python modules - No CI pipeline changes required - self-discovering architecture COMPATIBILITY: - All RST files follow existing Sphinx documentation structure - Maintained consistent formatting and style - Added proper automodule directives for API documentation - Prepared for automatic Sphinx build in CI/CD This update ensures code documentation accurately reflects the current codebase structure after Phase 1-3 implementations. Related commits: - 10686c1 (README architecture update) - 5f1d7ad (Root cleanup and archive)
1 parent 10686c1 commit 9d3a01a

File tree

6 files changed

+309
-0
lines changed

6 files changed

+309
-0
lines changed

‎doc/codeDocs/analyzers.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
analyzers package
2+
=================
3+
4+
.. automodule:: src.analyzers
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Module Overview
10+
---------------
11+
12+
The **analyzers** module provides quality analysis and benchmarking capabilities for the system. It includes tools for:
13+
14+
* **Quality Analysis**: Evaluate code quality, performance, and reliability
15+
* **Benchmarking**: Performance testing and metrics collection
16+
* **Code Metrics**: Complexity analysis and code health assessment
17+
* **Validation**: Automated quality checks and validation
18+
19+
Key Components
20+
--------------
21+
22+
Quality Analyzer
23+
~~~~~~~~~~~~~~~~
24+
25+
.. automodule:: src.analyzers.quality_analyzer
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Benchmark Runner
31+
~~~~~~~~~~~~~~~~
32+
33+
.. automodule:: src.analyzers.benchmark
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
:noindex:
38+
39+
Submodules
40+
----------
41+
42+
.. toctree::
43+
:maxdepth: 2
44+

‎doc/codeDocs/conversation.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
conversation package
2+
====================
3+
4+
.. automodule:: src.conversation
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Module Overview
10+
---------------
11+
12+
The **conversation** module provides conversational AI and context management capabilities. It enables:
13+
14+
* **Conversational Interfaces**: Natural language interaction with the system
15+
* **Context Management**: Maintain conversation history and context
16+
* **Dialog Flow**: Manage multi-turn conversations and state
17+
* **Intent Recognition**: Understand user intent from natural language
18+
19+
Key Components
20+
--------------
21+
22+
Conversation Manager
23+
~~~~~~~~~~~~~~~~~~~~
24+
25+
.. automodule:: src.conversation.manager
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Context Handler
31+
~~~~~~~~~~~~~~~
32+
33+
.. automodule:: src.conversation.context
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
:noindex:
38+
39+
Dialog System
40+
~~~~~~~~~~~~~
41+
42+
.. automodule:: src.conversation.dialog
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
:noindex:
47+
48+
Submodules
49+
----------
50+
51+
.. toctree::
52+
:maxdepth: 2
53+

‎doc/codeDocs/exploration.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
exploration package
2+
===================
3+
4+
.. automodule:: src.exploration
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Module Overview
10+
---------------
11+
12+
The **exploration** module provides interactive document exploration capabilities. Features include:
13+
14+
* **Interactive Navigation**: Browse and explore documents interactively
15+
* **Dynamic Querying**: Ask questions about document content
16+
* **Relationship Discovery**: Find connections between document sections
17+
* **Visual Exploration**: Interactive visualization of document structure
18+
19+
Key Components
20+
--------------
21+
22+
Explorer
23+
~~~~~~~~
24+
25+
.. automodule:: src.exploration.explorer
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Navigation System
31+
~~~~~~~~~~~~~~~~~
32+
33+
.. automodule:: src.exploration.navigator
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
:noindex:
38+
39+
Query Interface
40+
~~~~~~~~~~~~~~~
41+
42+
.. automodule:: src.exploration.query
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
:noindex:
47+
48+
Submodules
49+
----------
50+
51+
.. toctree::
52+
:maxdepth: 2
53+

‎doc/codeDocs/processors.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
processors package
2+
==================
3+
4+
.. automodule:: src.processors
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Module Overview
10+
---------------
11+
12+
The **processors** module provides document and text processing capabilities. It includes:
13+
14+
* **Document Processors**: Transform and process various document formats
15+
* **Text Processors**: Text cleaning, normalization, and transformation
16+
* **Content Extractors**: Extract structured content from unstructured data
17+
* **Format Converters**: Convert between different document formats
18+
19+
Key Components
20+
--------------
21+
22+
Document Processor
23+
~~~~~~~~~~~~~~~~~~
24+
25+
.. automodule:: src.processors.document
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Text Processor
31+
~~~~~~~~~~~~~~
32+
33+
.. automodule:: src.processors.text
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
:noindex:
38+
39+
Content Extractor
40+
~~~~~~~~~~~~~~~~~
41+
42+
.. automodule:: src.processors.extractor
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
:noindex:
47+
48+
Submodules
49+
----------
50+
51+
.. toctree::
52+
:maxdepth: 2
53+

‎doc/codeDocs/qa.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
qa package
2+
==========
3+
4+
.. automodule:: src.qa
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Module Overview
10+
---------------
11+
12+
The **qa** (Question-Answering) module provides intelligent question-answering capabilities over documents. Features include:
13+
14+
* **Document Q&A**: Answer questions based on document content
15+
* **Context-Aware Responses**: Maintain context across multiple questions
16+
* **Source Attribution**: Track and cite sources for answers
17+
* **Multi-Document Q&A**: Answer questions across multiple documents
18+
19+
Key Components
20+
--------------
21+
22+
QA Engine
23+
~~~~~~~~~
24+
25+
.. automodule:: src.qa.engine
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Answer Generator
31+
~~~~~~~~~~~~~~~~
32+
33+
.. automodule:: src.qa.generator
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
:noindex:
38+
39+
Context Manager
40+
~~~~~~~~~~~~~~~
41+
42+
.. automodule:: src.qa.context
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
:noindex:
47+
48+
Submodules
49+
----------
50+
51+
.. toctree::
52+
:maxdepth: 2
53+

‎doc/codeDocs/synthesis.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
synthesis package
2+
=================
3+
4+
.. automodule:: src.synthesis
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Module Overview
10+
---------------
11+
12+
The **synthesis** module provides document synthesis and generation capabilities. It enables:
13+
14+
* **Document Generation**: Create new documents from structured data
15+
* **Content Synthesis**: Combine information from multiple sources
16+
* **Report Generation**: Automated report creation and formatting
17+
* **Template-Based Synthesis**: Generate documents using templates
18+
19+
Key Components
20+
--------------
21+
22+
Synthesis Engine
23+
~~~~~~~~~~~~~~~~
24+
25+
.. automodule:: src.synthesis.engine
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
Document Generator
31+
~~~~~~~~~~~~~~~~~~
32+
33+
.. automodule:: src.synthesis.generator
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
:noindex:
38+
39+
Template Manager
40+
~~~~~~~~~~~~~~~~
41+
42+
.. automodule:: src.synthesis.templates
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
:noindex:
47+
48+
Submodules
49+
----------
50+
51+
.. toctree::
52+
:maxdepth: 2
53+

0 commit comments

Comments
 (0)