Enhance documentation and project structure

.gitignore

@@ -38,6 +38,7 @@ htmlcov/
 
 # Documentation builds
 docs/_build/
+site/
 
 # Logs
 server_logs/

Makefile

@@ -50,7 +50,27 @@ else
 endif
 
 docs:
-	cd docs && $(MAKE) html
+	@echo "Installing documentation dependencies..."
+	$(VENV_PIP) install -r requirements-docs.txt
+	@echo "Building documentation..."
+	mkdocs build
+
+docs-serve:
+	@echo "Installing documentation dependencies..."
+	$(VENV_PIP) install -r requirements-docs.txt
+	@echo "Starting documentation server..."
+	mkdocs serve
+
+docs-deploy:
+	@echo "Installing documentation dependencies..."
+	$(VENV_PIP) install -r requirements-docs.txt
+	@echo "Deploying documentation..."
+	mkdocs gh-deploy
+
+docs-api:
+	@echo "Generating API documentation..."
+	$(VENV_PYTHON) generate_api_docs.py
+	@echo "API documentation generated successfully!"
 
 lint:
 	flake8 src tests

README.md

@@ -39,7 +39,7 @@ python -m build
 
 ```bash
 # Run a stress test using a YAML configuration
-stress-run examples/api_test.yaml --users 500 --duration 60
+stress-run --test_config examples/api_test.yaml --request_config examples/requests.yaml
 
 # Start the monitoring dashboard
 stress-dashboard --mode websocket  # or --mode bokeh

docs/api/Http.md

@@ -0,0 +1,18 @@
+# Http
+
+This page contains the API documentation for the `gradual.runners.request.Http` module.
+
+::: gradual.runners.request.Http
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.runners.request.Http]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/SocketIO.md

@@ -0,0 +1,18 @@
+# Socketio
+
+This page contains the API documentation for the `gradual.runners.request.SocketIO` module.
+
+::: gradual.runners.request.SocketIO
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.runners.request.SocketIO]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/adapters.md

@@ -0,0 +1,18 @@
+# Adapters
+
+This page contains the API documentation for the `gradual.reporting.adapters` module.
+
+::: gradual.reporting.adapters
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.reporting.adapters]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/base.md

@@ -0,0 +1,18 @@
+# Base
+
+This page contains the API documentation for the `gradual.runners.request.base` module.
+
+::: gradual.runners.request.base
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.runners.request.base]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/configs.md

@@ -0,0 +1,18 @@
+# Configs
+
+This page contains the API documentation for the `gradual.configs` module.
+
+::: gradual.configs
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_", "!^gradual.configs.parser", "!^gradual.configs.phase", "!^gradual.configs.request", "!^gradual.configs.scenario", "!^gradual.configs.validate"]
+        preload_modules: [gradual.configs]
+        merge_init_into_class: true
+        show_submodules: false
+        show_if_no_docstring: true

docs/api/constants.md

@@ -0,0 +1,18 @@
+# Constants
+
+This page contains the API documentation for the `gradual.constants` module.
+
+::: gradual.constants
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_", "!^gradual.constants.request_types"]
+        preload_modules: [gradual.constants]
+        merge_init_into_class: true
+        show_submodules: false
+        show_if_no_docstring: true

docs/api/exceptions.md

@@ -0,0 +1,18 @@
+# Exceptions
+
+This page contains the API documentation for the `gradual.exceptions` module.
+
+::: gradual.exceptions
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.exceptions]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/iterators.md

@@ -0,0 +1,18 @@
+# Iterators
+
+This page contains the API documentation for the `gradual.runners.iterators` module.
+
+::: gradual.runners.iterators
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.runners.iterators]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/logger.md

@@ -0,0 +1,18 @@
+# Logger
+
+This page contains the API documentation for the `gradual.reporting.logger` module.
+
+::: gradual.reporting.logger
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.reporting.logger]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/logging.md

@@ -0,0 +1,18 @@
+# Logging
+
+This page contains the API documentation for the `gradual.reporting.adapters.logging` module.
+
+::: gradual.reporting.adapters.logging
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.reporting.adapters.logging]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/orchestrator.md

@@ -0,0 +1,18 @@
+# Orchestrator
+
+This page contains the API documentation for the `gradual.base.orchestrator` module.
+
+::: gradual.base.orchestrator
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.base.orchestrator]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/overview.md

@@ -0,0 +1,49 @@
+# API Reference
+
+This page provides comprehensive API documentation for the gradual package.
+
+## Available Modules
+
+The following modules are automatically discovered and documented:
+
+- [Base](base.md) - `gradual.base`
+- [Configs](configs.md) - `gradual.configs`
+- [Constants](constants.md) - `gradual.constants`
+- [Exceptions](exceptions.md) - `gradual.exceptions`
+- [Reporting](reporting.md) - `gradual.reporting`
+- [Runners](runners.md) - `gradual.runners`
+- [Parser](parser.md) - `gradual.configs.parser`
+- [Phase](phase.md) - `gradual.configs.phase`
+- [Request](request.md) - `gradual.configs.request`
+- [Scenario](scenario.md) - `gradual.configs.scenario`
+- [Validate](validate.md) - `gradual.configs.validate`
+- [Orchestrator](orchestrator.md) - `gradual.base.orchestrator`
+- [Request_Types](request_types.md) - `gradual.constants.request_types`
+- [Adapters](adapters.md) - `gradual.reporting.adapters`
+- [Logger](logger.md) - `gradual.reporting.logger`
+- [Stats](stats.md) - `gradual.reporting.stats`
+- [Base](base.md) - `gradual.reporting.adapters.base`
+- [Logging](logging.md) - `gradual.reporting.adapters.logging`
+- [Iterators](iterators.md) - `gradual.runners.iterators`
+- [Phase](phase.md) - `gradual.runners.phase`
+- [Request](request.md) - `gradual.runners.request`
+- [Runner](runner.md) - `gradual.runners.runner`
+- [Scenario](scenario.md) - `gradual.runners.scenario`
+- [Session](session.md) - `gradual.runners.session`
+- [Http](Http.md) - `gradual.runners.request.Http`
+- [Socketio](SocketIO.md) - `gradual.runners.request.SocketIO`
+- [Base](base.md) - `gradual.runners.request.base`
+
+
+## Automatic Discovery
+
+This documentation is automatically generated using a Python script that:
+1. Discovers all modules in the package
+2. Generates individual documentation files for each module
+3. Uses mkdocstrings to extract documentation from docstrings
+4. Updates automatically when you run the script
+
+To regenerate all API documentation, run:
+```bash
+python generate_api_docs.py
+```

docs/api/parser.md

@@ -0,0 +1,18 @@
+# Parser
+
+This page contains the API documentation for the `gradual.configs.parser` module.
+
+::: gradual.configs.parser
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.configs.parser]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/phase.md

@@ -0,0 +1,18 @@
+# Phase
+
+This page contains the API documentation for the `gradual.runners.phase` module.
+
+::: gradual.runners.phase
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.runners.phase]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true

docs/api/reporting.md

@@ -0,0 +1,18 @@
+# Reporting
+
+This page contains the API documentation for the `gradual.reporting` module.
+
+::: gradual.reporting
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_", "!^gradual.reporting.stats", "!^gradual.reporting.logger", "!^gradual.reporting.adapters"]
+        preload_modules: [gradual.reporting]
+        merge_init_into_class: true
+        show_submodules: false
+        show_if_no_docstring: true

docs/api/request.md

@@ -0,0 +1,18 @@
+# Request
+
+This page contains the API documentation for the `gradual.runners.request` module.
+
+::: gradual.runners.request
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_", "!^gradual.runners.request.Http", "!^gradual.runners.request.SocketIO"]
+        preload_modules: [gradual.runners.request]
+        merge_init_into_class: true
+        show_submodules: false
+        show_if_no_docstring: true

docs/api/request_types.md

@@ -0,0 +1,18 @@
+# Request_Types
+
+This page contains the API documentation for the `gradual.constants.request_types` module.
+
+::: gradual.constants.request_types
+    options:
+        show_source: true
+        show_root_heading: true
+        show_signature_annotations: true
+        show_category_heading: true
+        heading_level: 2
+        members_order: source
+        docstring_style: google
+        filters: ["!^_"]
+        preload_modules: [gradual.constants.request_types]
+        merge_init_into_class: true
+        show_submodules: true
+        show_if_no_docstring: true