Skip to content

Commit 232d6a9

Browse files
docs: improve api_reference formatting and remove duplicate scylladb content
1 parent 4cd72c7 commit 232d6a9

24 files changed

Lines changed: 314 additions & 218 deletions

docs/api_reference/adapters/base.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,52 @@
22

33
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.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the contract all SQLAlchemy-based adapters must fulfil.
88

99
::: archipy.adapters.base.sqlalchemy.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## session_manager_ports
15+
## Session Manager Ports
1516

1617
Abstract interface for SQLAlchemy session managers, decoupling session lifecycle from adapter logic.
1718

1819
::: archipy.adapters.base.sqlalchemy.session_manager_ports
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3
2224

23-
## session_manager_registry
25+
## Session Manager Registry
2426

2527
Registry for tracking and resolving active session manager instances.
2628

2729
::: archipy.adapters.base.sqlalchemy.session_manager_registry
2830
options:
29-
show_root_heading: true
3031
show_source: true
32+
show_root_toc_entry: false
33+
heading_level: 3
3134

32-
## session_managers
35+
## Session Managers
3336

3437
Concrete session manager implementations that handle SQLAlchemy session creation, scoping, and teardown.
3538

3639
::: archipy.adapters.base.sqlalchemy.session_managers
3740
options:
38-
show_root_heading: true
3941
show_source: true
42+
show_root_toc_entry: false
43+
heading_level: 3
4044

41-
## adapters
45+
## Adapters
4246

4347
The base SQLAlchemy adapter implements generic CRUD operations that concrete database adapters (PostgreSQL, SQLite, StarRocks) inherit from.
4448

4549
::: archipy.adapters.base.sqlalchemy.adapters
4650
options:
47-
show_root_heading: true
4851
show_source: true
52+
show_root_toc_entry: false
53+
heading_level: 3

docs/api_reference/adapters/elasticsearch.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
The `elasticsearch` adapter provides integration with Elasticsearch for full-text search, document indexing, and analytics queries.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the Elasticsearch adapter contract.
88

99
::: archipy.adapters.elasticsearch.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete Elasticsearch adapter implementing index management, document CRUD, and search operations.
1718

1819
::: archipy.adapters.elasticsearch.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3

docs/api_reference/adapters/email.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
The `email` adapter provides integration with email services for sending transactional and notification emails.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the email adapter contract.
88

99
::: archipy.adapters.email.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete email adapter implementing SMTP-based email sending with ArchiPy conventions.
1718

1819
::: archipy.adapters.email.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3

docs/api_reference/adapters/kafka.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
The `kafka` adapter provides integration with Apache Kafka for producing and consuming messages in event-driven architectures.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the Kafka adapter contract for message production and consumption.
88

99
::: archipy.adapters.kafka.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete Kafka adapter implementing producer and consumer patterns with ArchiPy conventions.
1718

1819
::: archipy.adapters.kafka.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3

docs/api_reference/adapters/keycloak.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
The `keycloak` adapter provides integration with Keycloak for identity and access management, including token validation, user management, and role-based access control.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the Keycloak adapter contract.
88

99
::: archipy.adapters.keycloak.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete Keycloak adapter wrapping the Keycloak REST API for authentication and authorization operations.
1718

1819
::: archipy.adapters.keycloak.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3

docs/api_reference/adapters/minio.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
The `minio` adapter provides integration with MinIO (and S3-compatible object storage) for uploading, downloading, and managing binary objects.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the MinIO adapter contract for object storage operations.
88

99
::: archipy.adapters.minio.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete MinIO adapter wrapping the MinIO Python SDK with ArchiPy conventions for object storage operations.
1718

1819
::: archipy.adapters.minio.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3

docs/api_reference/adapters/payment_gateways.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Concrete Parsian Shaparak payment gateway adapter implementing payment initiatio
1010

1111
::: archipy.adapters.internet_payment_gateways.ir.parsian.adapters
1212
options:
13-
show_root_heading: true
1413
show_source: true
14+
show_root_toc_entry: false
15+
heading_level: 3

docs/api_reference/adapters/postgres.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,32 @@
22

33
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.
44

5-
## session_managers
5+
## Session Managers
66

77
PostgreSQL-specific session manager handling connection pooling and lifecycle for PostgreSQL databases.
88

99
::: archipy.adapters.postgres.sqlalchemy.session_managers
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## session_manager_registry
15+
## Session Manager Registry
1516

1617
Registry for PostgreSQL session manager instances.
1718

1819
::: archipy.adapters.postgres.sqlalchemy.session_manager_registry
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3
2224

23-
## adapters
25+
## Adapters
2426

2527
Concrete PostgreSQL adapter built on top of the base SQLAlchemy adapter with PostgreSQL-specific configuration.
2628

2729
::: archipy.adapters.postgres.sqlalchemy.adapters
2830
options:
29-
show_root_heading: true
3031
show_source: true
32+
show_root_toc_entry: false
33+
heading_level: 3

docs/api_reference/adapters/redis.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,32 @@
22

33
The `redis` adapter provides a complete Redis integration including the concrete adapter, its abstract port interface, and a mock implementation for testing.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the Redis adapter contract.
88

99
::: archipy.adapters.redis.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete Redis adapter wrapping the Redis client with ArchiPy conventions for cache operations, pub/sub, and key-value management.
1718

1819
::: archipy.adapters.redis.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3
2224

23-
## mocks
25+
## Mocks
2426

2527
In-memory mock implementation of the Redis port for use in unit tests and BDD scenarios.
2628

2729
::: archipy.adapters.redis.mocks
2830
options:
29-
show_root_heading: true
3031
show_source: true
32+
show_root_toc_entry: false
33+
heading_level: 3

docs/api_reference/adapters/scylladb.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
The `scylladb` adapter provides integration with ScyllaDB (and Apache Cassandra) for high-throughput, low-latency wide-column store operations.
44

5-
## ports
5+
## Ports
66

77
Abstract port interface defining the ScyllaDB adapter contract.
88

99
::: archipy.adapters.scylladb.ports
1010
options:
11-
show_root_heading: true
1211
show_source: true
12+
show_root_toc_entry: false
13+
heading_level: 3
1314

14-
## adapters
15+
## Adapters
1516

1617
Concrete ScyllaDB adapter implementing session management and query execution for ScyllaDB/Cassandra clusters.
1718

1819
::: archipy.adapters.scylladb.adapters
1920
options:
20-
show_root_heading: true
2121
show_source: true
22+
show_root_toc_entry: false
23+
heading_level: 3

0 commit comments

Comments
 (0)