LCORE-3444: Properly formatted devel doc

scripts/gen_doc.py

@@ -44,6 +44,7 @@ def generate_docfile(directory: Path) -> None:
         for file in files:
             if file.endswith(".py"):
                 print(f"## [{file}]({file})", file=indexfile)
+                print(file=indexfile)
                 with open(file, encoding="utf-8") as fin:
                     source = fin.read()
                 try:

src/README.md

@@ -1,29 +1,38 @@
 # List of source files stored in `src` directory
 
 ## [__init__.py](__init__.py)
+
 Main classes for the Lightspeed Core Stack REST API service.
 
 ## [client.py](client.py)
+
 Llama Stack client retrieval class.
 
 ## [configuration.py](configuration.py)
+
 Configuration loader.
 
 ## [constants.py](constants.py)
+
 Constants used in business logic.
 
 ## [lightspeed_stack.py](lightspeed_stack.py)
+
 Entry point to the Lightspeed Core Stack REST API service.
 
 ## [llama_stack_configuration.py](llama_stack_configuration.py)
+
 Llama Stack configuration enrichment and synthesis.
 
 ## [log.py](log.py)
+
 Log utilities.
 
 ## [sentry.py](sentry.py)
+
 Sentry error tracking initialization and configuration.
 
 ## [version.py](version.py)
+
 Service version that is read by project manager tools.
 

src/a2a_storage/README.md

@@ -1,20 +1,26 @@
 # List of source files stored in `src/a2a_storage` directory
 
 ## [__init__.py](__init__.py)
+
 A2A protocol persistent storage components.
 
 ## [context_store.py](context_store.py)
+
 Abstract base class for A2A context-to-conversation mapping storage.
 
 ## [in_memory_context_store.py](in_memory_context_store.py)
+
 In-memory implementation of A2A context store.
 
 ## [postgres_context_store.py](postgres_context_store.py)
+
 PostgreSQL implementation of A2A context store.
 
 ## [sqlite_context_store.py](sqlite_context_store.py)
+
 SQLite implementation of A2A context store.
 
 ## [storage_factory.py](storage_factory.py)
+
 Factory for creating A2A storage backends.
 

src/app/README.md

@@ -1,14 +1,18 @@
 # List of source files stored in `src/app` directory
 
 ## [__init__.py](__init__.py)
+
 REST API service based on FastAPI.
 
 ## [database.py](database.py)
+
 Database engine management.
 
 ## [main.py](main.py)
+
 Definition of FastAPI based web service.
 
 ## [routers.py](routers.py)
+
 REST API routers.
 

src/app/endpoints/README.md

@@ -1,86 +1,114 @@
 # List of source files stored in `src/app/endpoints` directory
 
 ## [__init__.py](__init__.py)
+
 Implementation of all endpoints.
 
 ## [a2a.py](a2a.py)
+
 Handler for A2A (Agent-to-Agent) protocol endpoints using Responses API.
 
 ## [a2a_openapi.py](a2a_openapi.py)
+
 OpenAPI-only metadata for A2A JSON-RPC routes.
 
 ## [authorized.py](authorized.py)
+
 Handler for REST API call to authorized endpoint.
 
 ## [config.py](config.py)
+
 Handler for REST API call to retrieve service configuration.
 
 ## [conversations_v1.py](conversations_v1.py)
+
 Handler for REST API calls to manage conversation history using Conversations API.
 
 ## [conversations_v2.py](conversations_v2.py)
+
 Handler for REST API calls to manage conversation history.
 
 ## [feedback.py](feedback.py)
+
 Handler for REST API endpoint for user feedback.
 
 ## [health.py](health.py)
+
 Handlers for health REST API endpoints.
 
 ## [info.py](info.py)
+
 Handler for REST API call to provide info.
 
 ## [mcp_auth.py](mcp_auth.py)
+
 Handler for REST API calls related to MCP server authentication.
 
 ## [mcp_servers.py](mcp_servers.py)
+
 Handler for REST API calls to dynamically manage MCP servers.
 
 ## [metrics.py](metrics.py)
+
 Handler for REST API call to provide metrics.
 
 ## [models.py](models.py)
+
 Handler for REST API call to list available models.
 
 ## [prompts.py](prompts.py)
+
 Handler for REST API calls to manage Llama Stack stored prompt templates.
 
 ## [providers.py](providers.py)
+
 Handler for REST API calls to list and retrieve available providers.
 
 ## [query.py](query.py)
+
 Handler for REST API call to provide answer to query using Response API.
 
 ## [rags.py](rags.py)
+
 Handler for REST API calls to list and retrieve available RAGs.
 
 ## [responses.py](responses.py)
+
 Handler for REST API call to provide answer using Responses API (LCORE specification).
 
 ## [responses_telemetry.py](responses_telemetry.py)
+
 Splunk telemetry helpers for the Responses API endpoint.
 
 ## [rlsapi_v1.py](rlsapi_v1.py)
+
 Handler for RHEL Lightspeed rlsapi v1 REST API endpoints.
 
 ## [root.py](root.py)
+
 Handler for the / endpoint.
 
 ## [saved_prompts.py](saved_prompts.py)
+
 Handler for REST API calls to manage saved prompts.
 
 ## [shields.py](shields.py)
+
 Handler for REST API call to list available shields.
 
 ## [stream_interrupt.py](stream_interrupt.py)
+
 Endpoint for interrupting in-progress streaming query requests.
 
 ## [streaming_query.py](streaming_query.py)
+
 Streaming query handler using Responses API.
 
 ## [tools.py](tools.py)
+
 Handler for REST API call to list available tools from MCP servers.
 
 ## [vector_stores.py](vector_stores.py)
+
 Handler for REST API calls to manage vector stores and files.
 

src/authentication/README.md

@@ -1,32 +1,42 @@
 # List of source files stored in `src/authentication` directory
 
 ## [__init__.py](__init__.py)
+
 This package contains authentication code and modules.
 
 ## [api_key_token.py](api_key_token.py)
+
 Authentication flow for FastAPI endpoints with a provided API key.
 
 ## [interface.py](interface.py)
+
 Abstract base class for all authentication method implementations.
 
 ## [jwk_token.py](jwk_token.py)
+
 Manage authentication flow for FastAPI endpoints with JWK based JWT auth.
 
 ## [k8s.py](k8s.py)
+
 Manage authentication flow for FastAPI endpoints with K8S/OCP.
 
 ## [noop.py](noop.py)
+
 Manage authentication flow for FastAPI endpoints with no-op auth.
 
 ## [noop_with_token.py](noop_with_token.py)
+
 Manage authentication flow for FastAPI endpoints with no-op auth and provided user token.
 
 ## [rh_identity.py](rh_identity.py)
+
 Red Hat Identity header authentication for FastAPI endpoints.
 
 ## [trusted_proxy.py](trusted_proxy.py)
+
 Trusted-proxy authentication module for requests forwarded by a K8s proxy.
 
 ## [utils.py](utils.py)
+
 Authentication utility functions.
 

src/authorization/README.md

@@ -1,14 +1,18 @@
 # List of source files stored in `src/authorization` directory
 
 ## [__init__.py](__init__.py)
+
 Authorization module for role-based access control.
 
 ## [azure_token_manager.py](azure_token_manager.py)
+
 Azure Entra ID token manager for Azure OpenAI authentication.
 
 ## [middleware.py](middleware.py)
+
 Authorization middleware and decorators.
 
 ## [resolvers.py](resolvers.py)
+
 Authorization resolvers for role evaluation and access control.
 

src/cache/README.md

@@ -1,29 +1,38 @@
 # List of source files stored in `src/cache` directory
 
 ## [__init__.py](__init__.py)
+
 Various cache implementations.
 
 ## [cache.py](cache.py)
+
 Abstract class that is parent for all cache implementations.
 
 ## [cache_entry.py](cache_entry.py)
+
 Model for conversation history cache entry.
 
 ## [cache_error.py](cache_error.py)
+
 Any exception that can occur during cache operations.
 
 ## [cache_factory.py](cache_factory.py)
+
 Cache factory class.
 
 ## [in_memory_cache.py](in_memory_cache.py)
+
 In-memory cache implementation.
 
 ## [noop_cache.py](noop_cache.py)
+
 No-operation cache implementation.
 
 ## [postgres_cache.py](postgres_cache.py)
+
 PostgreSQL cache implementation.
 
 ## [sqlite_cache.py](sqlite_cache.py)
+
 Cache that uses SQLite to store cached values.
 

src/data/README.md

@@ -1,5 +1,6 @@
 # List of source files stored in `src/data` directory
 
 ## [__init__.py](__init__.py)
+
 Package-shipped data files for Lightspeed Core Stack.
 

src/metrics/README.md

@@ -1,11 +1,14 @@
 # List of source files stored in `src/metrics` directory
 
 ## [__init__.py](__init__.py)
+
 Metrics module for Lightspeed Core Stack.
 
 ## [recording.py](recording.py)
+
 Recording helpers for Prometheus metrics.
 
 ## [utils.py](utils.py)
+
 Utility functions for metrics handling.
 

src/models/README.md

@@ -1,11 +1,14 @@
 # List of source files stored in `src/models` directory
 
 ## [__init__.py](__init__.py)
+
 Pydantic models.
 
 ## [compaction.py](compaction.py)
+
 Pydantic models for conversation compaction.
 
 ## [config.py](config.py)
+
 Model with service configuration.
 

src/models/api/README.md

@@ -1,5 +1,6 @@
 # List of source files stored in `src/models/api` directory
 
 ## [__init__.py](__init__.py)
+
 Typed HTTP API models (OpenAPI-oriented) for FastAPI routes.
 

src/models/api/requests/README.md

@@ -1,35 +1,46 @@
 # List of source files stored in `src/models/api/requests` directory
 
 ## [__init__.py](__init__.py)
+
 Concrete REST API request models grouped by domain.
 
 ## [catalog.py](catalog.py)
+
 Request models for catalog-related endpoints.
 
 ## [conversations.py](conversations.py)
+
 Request models for conversation endpoints.
 
 ## [feedback.py](feedback.py)
+
 Request models for feedback endpoints.
 
 ## [mcp_servers.py](mcp_servers.py)
+
 Request models for MCP server registration.
 
 ## [prompts.py](prompts.py)
+
 Request models for prompt template endpoints.
 
 ## [query.py](query.py)
+
 Request models for query and streaming interrupt endpoints.
 
 ## [responses_openai.py](responses_openai.py)
+
 Request model for the OpenAI-compatible Responses API.
 
 ## [rlsapi.py](rlsapi.py)
+
 Models for rlsapi v1 REST API requests.
 
 ## [saved_prompts.py](saved_prompts.py)
+
 Request models for saved prompts endpoints.
 
 ## [vector_stores.py](vector_stores.py)
+
 Request models for vector store and file endpoints.