Skip to content

Commit 97fa171

Browse files
committed
update docs
Signed-off-by: Lance Drane <[email protected]>
1 parent ae0dab3 commit 97fa171

File tree

8 files changed

+60
-36
lines changed

8 files changed

+60
-36
lines changed

docs/api/callback_definitions.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
====================
2+
Callback Definitions
3+
====================
4+
5+
Shared
6+
======
7+
8+
.. automodule:: intersect_sdk.shared_callback_definitions
9+
:members:
10+
:undoc-members:
11+
:exclude-members: model_computed_fields, model_config, model_fields
12+
13+
Client
14+
======
15+
16+
.. automodule:: intersect_sdk.client_callback_definitions
17+
:members:
18+
:undoc-members:
19+
:exclude-members: model_computed_fields, model_config, model_fields
20+
21+
Service
22+
=======
23+
24+
.. automodule:: intersect_sdk.service_callback_definitions
25+
:members:
26+
:undoc-members:
27+
:exclude-members: model_computed_fields, model_config, model_fields

docs/api/client_callback_definitions.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/config.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
======
2+
Config
3+
======
4+
5+
Config - Shared
6+
===============
7+
8+
.. automodule:: intersect_sdk.config.shared
9+
:members:
10+
:undoc-members:
11+
:exclude-members: model_computed_fields, model_config, model_fields
12+
13+
Config - Service
14+
================
15+
16+
.. automodule:: intersect_sdk.config.service
17+
:members:
18+
:undoc-members:
19+
:exclude-members: model_computed_fields, model_config, model_fields
20+
21+
Config - Client
22+
===============
23+
24+
.. automodule:: intersect_sdk.config.client
25+
:members:
26+
:undoc-members:
27+
:exclude-members: model_computed_fields, model_config, model_fields

docs/api/config_client.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/config_service.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/api/config_shared.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,14 @@ This site provides documentation for INTERSECT's Python SDK. See the getting sta
3131
:maxdepth: 2
3232
:caption: API documentation
3333

34-
api/config_service
35-
api/config_client
36-
api/config_shared
34+
api/config
3735
api/core_definitions
3836
api/schema
3937
api/capability
40-
api/service_definitions
4138
api/service
42-
api/client_callback_definitions
39+
api/service_definitions
4340
api/client
41+
api/callback_definitions
4442
api/app_lifecycle
4543
api/constants
4644
api/version

src/intersect_sdk/capability/base.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ class IntersectBaseCapabilityImplementation:
2626
"""Base class for all capabilities.
2727
2828
EVERY capability implementation will need to extend this class. Additionally, if you redefine the constructor,
29-
you MUST call super.__init__() .
29+
you MUST call `super.__init__()` .
3030
"""
3131

3232
def __init__(self) -> None:
3333
"""This constructor just sets up observers.
3434
35-
NOTE: If you write your own constructor, you MUST call super.__init__() inside of it. The Service will throw an error if you don't.
35+
NOTE: If you write your own constructor, you MUST call `super.__init__()` inside of it. The Service will throw an error if you don't.
3636
"""
3737
self._capability_name: str = 'InvalidCapability'
3838
"""
@@ -49,7 +49,7 @@ def __init__(self) -> None:
4949
def __init_subclass__(cls) -> None:
5050
"""This prevents users from overriding a few key functions.
5151
52-
General rule of thumb is that any function which starts with "intersect_sdk_" is a protected namespace for defining
52+
General rule of thumb is that any function which starts with `intersect_sdk_` is a protected namespace for defining
5353
the INTERSECT-SDK public API between a capability and its observers.
5454
"""
5555
if (

0 commit comments

Comments
 (0)