Skip to content

Commit 409a152

Browse files
docs: revamp adapter examples, consolidate payment gateway docs, and add mkdocs nav updates
- Rename parsian_payment.md to payment_gateways.md with unified content - Refactor and trim examples for redis, temporal, elasticsearch, postgres adapters - Add hide/copy code block buttons across all example and reference pages - Expand scylladb, starrocks, kafka, keycloak, minio, sqlite examples - Update mkdocs.yml navigation to reflect new structure
1 parent 232d6a9 commit 409a152

60 files changed

Lines changed: 739 additions & 885 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api_reference/adapters/base.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Base SQLAlchemy
3+
description: API reference for the base SQLAlchemy adapter ports, session managers, and registry.
4+
---
5+
16
# Base SQLAlchemy
27

38
The `base/sqlalchemy` subpackage provides the foundational SQLAlchemy components shared across all relational database adapters, including the abstract port interface, session managers, and session manager registries.
@@ -8,7 +13,6 @@ Abstract port interface defining the contract all SQLAlchemy-based adapters must
813

914
::: archipy.adapters.base.sqlalchemy.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,7 +22,6 @@ Abstract interface for SQLAlchemy session managers, decoupling session lifecycle
1822

1923
::: archipy.adapters.base.sqlalchemy.session_manager_ports
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3
2427

@@ -28,7 +31,6 @@ Registry for tracking and resolving active session manager instances.
2831

2932
::: archipy.adapters.base.sqlalchemy.session_manager_registry
3033
options:
31-
show_source: true
3234
show_root_toc_entry: false
3335
heading_level: 3
3436

@@ -38,7 +40,6 @@ Concrete session manager implementations that handle SQLAlchemy session creation
3840

3941
::: archipy.adapters.base.sqlalchemy.session_managers
4042
options:
41-
show_source: true
4243
show_root_toc_entry: false
4344
heading_level: 3
4445

@@ -48,6 +49,5 @@ The base SQLAlchemy adapter implements generic CRUD operations that concrete dat
4849

4950
::: archipy.adapters.base.sqlalchemy.adapters
5051
options:
51-
show_source: true
5252
show_root_toc_entry: false
5353
heading_level: 3

docs/api_reference/adapters/elasticsearch.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Elasticsearch
3+
description: API reference for the Elasticsearch adapter ports, adapters, and mocks.
4+
---
5+
16
# Elasticsearch
27

38
The `elasticsearch` adapter provides integration with Elasticsearch for full-text search, document indexing, and analytics queries.
@@ -8,7 +13,6 @@ Abstract port interface defining the Elasticsearch adapter contract.
813

914
::: archipy.adapters.elasticsearch.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,6 +22,5 @@ Concrete Elasticsearch adapter implementing index management, document CRUD, and
1822

1923
::: archipy.adapters.elasticsearch.adapters
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3

docs/api_reference/adapters/email.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Email
3+
description: API reference for the email adapter ports, adapters, and mocks.
4+
---
5+
16
# Email
27

38
The `email` adapter provides integration with email services for sending transactional and notification emails.
@@ -8,7 +13,6 @@ Abstract port interface defining the email adapter contract.
813

914
::: archipy.adapters.email.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,6 +22,5 @@ Concrete email adapter implementing SMTP-based email sending with ArchiPy conven
1822

1923
::: archipy.adapters.email.adapters
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3

docs/api_reference/adapters/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Adapters Overview
3+
description: Overview of all available ArchiPy adapter integrations.
4+
---
5+
16
# Adapters
27

38
The `adapters` module provides concrete implementations of external system integrations following the Ports & Adapters pattern. Each adapter directory exposes a `ports.py` (abstract interface) and an `adapters.py` (concrete implementation).

docs/api_reference/adapters/kafka.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Kafka
3+
description: API reference for the Kafka adapter ports, adapters, and mocks.
4+
---
5+
16
# Kafka
27

38
The `kafka` adapter provides integration with Apache Kafka for producing and consuming messages in event-driven architectures.
@@ -8,7 +13,6 @@ Abstract port interface defining the Kafka adapter contract for message producti
813

914
::: archipy.adapters.kafka.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,6 +22,5 @@ Concrete Kafka adapter implementing producer and consumer patterns with ArchiPy
1822

1923
::: archipy.adapters.kafka.adapters
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3

docs/api_reference/adapters/keycloak.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Keycloak
3+
description: API reference for the Keycloak adapter ports, adapters, and mocks.
4+
---
5+
16
# Keycloak
27

38
The `keycloak` adapter provides integration with Keycloak for identity and access management, including token validation, user management, and role-based access control.
@@ -8,7 +13,6 @@ Abstract port interface defining the Keycloak adapter contract.
813

914
::: archipy.adapters.keycloak.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,6 +22,5 @@ Concrete Keycloak adapter wrapping the Keycloak REST API for authentication and
1822

1923
::: archipy.adapters.keycloak.adapters
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3

docs/api_reference/adapters/minio.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: MinIO
3+
description: API reference for the MinIO adapter ports, adapters, and mocks.
4+
---
5+
16
# MinIO
27

38
The `minio` adapter provides integration with MinIO (and S3-compatible object storage) for uploading, downloading, and managing binary objects.
@@ -8,7 +13,6 @@ Abstract port interface defining the MinIO adapter contract for object storage o
813

914
::: archipy.adapters.minio.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,6 +22,5 @@ Concrete MinIO adapter wrapping the MinIO Python SDK with ArchiPy conventions fo
1822

1923
::: archipy.adapters.minio.adapters
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1+
---
2+
title: Payment Gateways
3+
description: API reference for the internet payment gateway adapters including Parsian Shaparak.
4+
---
5+
16
# Payment Gateways
27

38
The `internet_payment_gateways` adapter provides integration with internet payment gateways. Currently supports Parsian Shaparak, an Iranian payment gateway.
49

510
## Parsian Shaparak
611

7-
### adapters
12+
## Adapters
813

914
Concrete Parsian Shaparak payment gateway adapter implementing payment initiation, verification, and reversal.
1015

1116
::: archipy.adapters.internet_payment_gateways.ir.parsian.adapters
1217
options:
13-
show_source: true
1418
show_root_toc_entry: false
1519
heading_level: 3

docs/api_reference/adapters/postgres.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: PostgreSQL
3+
description: API reference for the PostgreSQL adapter session managers and adapters.
4+
---
5+
16
# PostgreSQL
27

38
The `postgres/sqlalchemy` adapter provides a PostgreSQL-specific SQLAlchemy integration, including a concrete adapter, session manager, and session manager registry that extend the base SQLAlchemy components.
@@ -8,7 +13,6 @@ PostgreSQL-specific session manager handling connection pooling and lifecycle fo
813

914
::: archipy.adapters.postgres.sqlalchemy.session_managers
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,7 +22,6 @@ Registry for PostgreSQL session manager instances.
1822

1923
::: archipy.adapters.postgres.sqlalchemy.session_manager_registry
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3
2427

@@ -28,6 +31,5 @@ Concrete PostgreSQL adapter built on top of the base SQLAlchemy adapter with Pos
2831

2932
::: archipy.adapters.postgres.sqlalchemy.adapters
3033
options:
31-
show_source: true
3234
show_root_toc_entry: false
3335
heading_level: 3

docs/api_reference/adapters/redis.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Redis
3+
description: API reference for the Redis adapter ports, adapters, and mocks.
4+
---
5+
16
# Redis
27

38
The `redis` adapter provides a complete Redis integration including the concrete adapter, its abstract port interface, and a mock implementation for testing.
@@ -8,7 +13,6 @@ Abstract port interface defining the Redis adapter contract.
813

914
::: archipy.adapters.redis.ports
1015
options:
11-
show_source: true
1216
show_root_toc_entry: false
1317
heading_level: 3
1418

@@ -18,7 +22,6 @@ Concrete Redis adapter wrapping the Redis client with ArchiPy conventions for ca
1822

1923
::: archipy.adapters.redis.adapters
2024
options:
21-
show_source: true
2225
show_root_toc_entry: false
2326
heading_level: 3
2427

@@ -28,6 +31,5 @@ In-memory mock implementation of the Redis port for use in unit tests and BDD sc
2831

2932
::: archipy.adapters.redis.mocks
3033
options:
31-
show_source: true
3234
show_root_toc_entry: false
3335
heading_level: 3

0 commit comments

Comments
 (0)