Skip to content

Commit 6735b3e

Browse files
committed
fix: readthedocs
1 parent c9009a9 commit 6735b3e

2 files changed

Lines changed: 33 additions & 19 deletions

File tree

docs/source/api.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,48 +45,61 @@ This page provides detailed API documentation for the Replane Python SDK.
4545

4646
```{eval-rst}
4747
.. autoclass:: replane.Config
48-
:members:
49-
:undoc-members:
48+
:no-index:
5049
```
5150

51+
**Attributes:**
52+
53+
- `name` (str): Unique identifier for this config.
54+
- `value` (Any): The base/default value returned when no overrides match.
55+
- `overrides` (tuple[Override, ...]): List of override rules evaluated in order.
56+
5257
### Override
5358

5459
```{eval-rst}
5560
.. autoclass:: replane.Override
56-
:members:
57-
:undoc-members:
61+
:no-index:
5862
```
5963

64+
**Attributes:**
65+
66+
- `name` (str): Name/description of this override rule.
67+
- `conditions` (tuple[Condition, ...]): Conditions that must all match.
68+
- `value` (Any): Value to return when conditions match.
69+
6070
### Conditions
6171

6272
```{eval-rst}
6373
.. autoclass:: replane.PropertyCondition
64-
:members:
65-
:undoc-members:
74+
:no-index:
6675
6776
.. autoclass:: replane.SegmentationCondition
68-
:members:
69-
:undoc-members:
77+
:no-index:
7078
7179
.. autoclass:: replane.AndCondition
72-
:members:
73-
:undoc-members:
80+
:no-index:
7481
7582
.. autoclass:: replane.OrCondition
76-
:members:
77-
:undoc-members:
83+
:no-index:
7884
7985
.. autoclass:: replane.NotCondition
80-
:members:
81-
:undoc-members:
86+
:no-index:
8287
```
8388

8489
### Context
8590

86-
```{eval-rst}
87-
.. autoclass:: replane.Context
88-
:members:
89-
:undoc-members:
91+
Context is a `TypedDict` representing runtime context for override evaluation.
92+
It's a dictionary with string keys and primitive values (`str`, `int`, `float`, `bool`, or `None`).
93+
94+
```python
95+
from replane import Context
96+
97+
context: Context = {
98+
"user_id": "user-123",
99+
"plan": "premium",
100+
"region": "us-east",
101+
"is_beta": True,
102+
}
90103
```
91104

92105
## Errors

replane/types.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ class Context(TypedDict, total=False):
1717
Context is a dictionary of string keys to primitive values.
1818
Common properties include user IDs, subscription plans, regions, etc.
1919
20-
Example:
20+
Example::
21+
2122
context: Context = {
2223
"user_id": "user-123",
2324
"plan": "premium",

0 commit comments

Comments
 (0)