docs: enhance documentation with API references and mkdocstrings integration

.readthedocs.yaml

@@ -17,6 +17,6 @@ mkdocs:
 # Optionally, but recommended,
 # declare the Python requirements required to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/api.md

@@ -0,0 +1,22 @@
+# API Reference
+
+This section contains the complete API reference for the Hatchling project.
+
+## Overview
+
+Hatchling is a Python application that provides a chat interface with LLM integration and MCP (Model Context Protocol) support.
+
+## Package Structure
+
+- [Core Modules](api/core.md) - Core functionality including chat, LLM, and logging
+- [Configuration](api/config.md) - Settings and configuration management
+- [UI Components](api/ui.md) - User interface and command handling
+- [MCP Utils](api/mcp_utils.md) - Model Context Protocol utilities
+- [Main Application](api/app.md) - Main application entry point
+
+## Quick Start
+
+```python
+from hatchling import app
+# See individual module documentation for usage examples
+```

docs/api/app.md

@@ -0,0 +1,5 @@
+# Main Application API
+
+::: hatchling.app
+
+This module contains the main entry point for the Hatchling application.

docs/api/config.md

@@ -0,0 +1,29 @@
+# Configuration API
+
+::: hatchling.config
+
+## Settings Management
+
+::: hatchling.config.settings
+::: hatchling.config.settings_registry
+::: hatchling.config.settings_access_level
+
+## LLM Settings
+
+::: hatchling.config.llm_settings
+::: hatchling.config.openai_settings
+::: hatchling.config.ollama_settings
+
+## Other Settings
+
+::: hatchling.config.path_settings
+::: hatchling.config.tool_calling_settings
+::: hatchling.config.ui_settings
+
+## Internationalization
+
+::: hatchling.config.i18n
+
+## Languages
+
+::: hatchling.config.languages

docs/api/core.md

@@ -0,0 +1,15 @@
+# Core Modules API
+
+::: hatchling.core
+
+## Chat Module
+
+::: hatchling.core.chat
+
+## LLM Module
+
+::: hatchling.core.llm
+
+## Logging Module
+
+::: hatchling.core.logging

docs/api/mcp_utils.md

@@ -0,0 +1,16 @@
+# MCP Utils API
+
+::: hatchling.mcp_utils
+
+## Core MCP Components
+
+::: hatchling.mcp_utils.client
+::: hatchling.mcp_utils.manager
+::: hatchling.mcp_utils.mcp_server_api
+
+## Tool Management
+
+::: hatchling.mcp_utils.mcp_tool_call_subscriber
+::: hatchling.mcp_utils.mcp_tool_data
+::: hatchling.mcp_utils.mcp_tool_execution
+::: hatchling.mcp_utils.mcp_tool_lifecycle_subscriber

docs/api/ui.md

@@ -0,0 +1,23 @@
+# UI Components API
+
+::: hatchling.ui
+
+## Command System
+
+::: hatchling.ui.abstract_commands
+::: hatchling.ui.base_commands
+::: hatchling.ui.chat_command_handler
+::: hatchling.ui.command_completion
+::: hatchling.ui.command_lexer
+
+## Chat Interface
+
+::: hatchling.ui.cli_chat
+::: hatchling.ui.cli_event_subscriber
+
+## Specific Commands
+
+::: hatchling.ui.hatch_commands
+::: hatchling.ui.mcp_commands
+::: hatchling.ui.model_commands
+::: hatchling.ui.settings_commands

docs/requirements.txt

@@ -0,0 +1,2 @@
+mkdocstrings
+mkdocstrings-python

mkdocs.yml

@@ -23,12 +23,25 @@ nav:
       - Event System Architecture: articles/devs/event_system_architecture.md
       - i18n Support: articles/devs/i18n_support.md
       - Contributing: articles/devs/CONTRIBUTING.md
+      - API Reference: api.md
   - Appendices:
       - Glossary: articles/appendices/glossary.md
   - Changelog: CHANGELOG.md
 
 plugins:
   - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: true
+            show_root_heading: true
+            show_root_toc_entry: false
+            heading_level: 2
+            show_category_heading: true
+            show_labels: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
 
 markdown_extensions:
   - admonition