Skip to content

Commit d15f8f2

Browse files
Aryamanz29claude
Aryamanz29
and
claude
committed
docs: use module-level ::: directives for auto-updating API reference
Switch all API reference pages from class-level to module-level ::: directives so any new class/function added to an existing module is automatically included in the docs without manual edits: - client.md: one ::: per .py file in pyatlan/client/ (24 modules) - cache.md: one ::: per .py file in pyatlan/cache/ (10 modules) - events.md: one ::: per .py file in pyatlan/events/ (2 modules) - model.md: expanded to cover all 30+ pyatlan/model/*.py modules utils.md and errors.md already used module-level directives. Asset pages remain class-level (generated by class_generator.py). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 7841182 commit d15f8f2

4 files changed

Lines changed: 167 additions & 37 deletions

File tree

‎docs/api/cache.md‎

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,21 @@
11
# Cache
22

3-
## AtlanTagCache
3+
::: pyatlan.cache.atlan_tag_cache
44

5-
::: pyatlan.cache.atlan_tag_cache.AtlanTagCache
5+
::: pyatlan.cache.custom_metadata_cache
66

7-
## CustomMetadataCache
7+
::: pyatlan.cache.enum_cache
88

9-
::: pyatlan.cache.custom_metadata_cache.CustomMetadataCache
9+
::: pyatlan.cache.group_cache
1010

11-
## EnumCache
11+
::: pyatlan.cache.role_cache
1212

13-
::: pyatlan.cache.enum_cache.EnumCache
13+
::: pyatlan.cache.user_cache
1414

15-
## GroupCache
15+
::: pyatlan.cache.connection_cache
1616

17-
::: pyatlan.cache.group_cache.GroupCache
17+
::: pyatlan.cache.source_tag_cache
1818

19-
## RoleCache
19+
::: pyatlan.cache.abstract_asset_cache
2020

21-
::: pyatlan.cache.role_cache.RoleCache
22-
23-
## UserCache
24-
25-
::: pyatlan.cache.user_cache.UserCache
26-
27-
## ConnectionCache
28-
29-
::: pyatlan.cache.connection_cache.ConnectionCache
30-
31-
## SourceTagCache
32-
33-
::: pyatlan.cache.source_tag_cache.SourceTagCache
21+
::: pyatlan.cache.dq_template_config_cache

‎docs/api/client.md‎

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

33
## AtlanClient
44

5-
::: pyatlan.client.atlan.AtlanClient
5+
::: pyatlan.client.atlan
66

77
## Asset Client
88

9-
::: pyatlan.client.asset.AssetClient
9+
::: pyatlan.client.asset
1010

1111
## Audit Client
1212

13-
::: pyatlan.client.audit.AuditClient
13+
::: pyatlan.client.audit
1414

1515
## File Client
1616

17-
::: pyatlan.client.file.FileClient
17+
::: pyatlan.client.file
1818

1919
## Group Client
2020

21-
::: pyatlan.client.group.GroupClient
21+
::: pyatlan.client.group
2222

2323
## Role Client
2424

25-
::: pyatlan.client.role.RoleClient
25+
::: pyatlan.client.role
2626

2727
## Token Client
2828

29-
::: pyatlan.client.token.TokenClient
29+
::: pyatlan.client.token
3030

3131
## User Client
3232

33-
::: pyatlan.client.user.UserClient
33+
::: pyatlan.client.user
3434

3535
## Typedef Client
3636

37-
::: pyatlan.client.typedef.TypeDefClient
37+
::: pyatlan.client.typedef
3838

3939
## Workflow Client
4040

41-
::: pyatlan.client.workflow.WorkflowClient
41+
::: pyatlan.client.workflow
42+
43+
## Credential Client
44+
45+
::: pyatlan.client.credential
46+
47+
## Contract Client
48+
49+
::: pyatlan.client.contract
50+
51+
## Query Client
52+
53+
::: pyatlan.client.query
54+
55+
## Search Log Client
56+
57+
::: pyatlan.client.search_log
58+
59+
## Task Client
60+
61+
::: pyatlan.client.task
62+
63+
## SSO Client
64+
65+
::: pyatlan.client.sso
66+
67+
## Open Lineage Client
68+
69+
::: pyatlan.client.open_lineage
70+
71+
## Impersonation Client
72+
73+
::: pyatlan.client.impersonate
74+
75+
## Admin Client
76+
77+
::: pyatlan.client.admin
78+
79+
## OAuth
80+
81+
::: pyatlan.client.oauth
82+
83+
::: pyatlan.client.oauth_client

‎docs/api/events.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Events
22

3-
## AtlanEventHandler
4-
5-
::: pyatlan.events.atlan_event_handler.AtlanEventHandler
6-
7-
## AtlanLambdaHandler
3+
::: pyatlan.events.atlan_event_handler
84

95
::: pyatlan.events.atlan_lambda_handler

‎docs/api/model.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,114 @@
44

55
::: pyatlan.model.search
66

7+
## Fluent Search
8+
9+
::: pyatlan.model.fluent_search
10+
711
## Typedef
812

913
::: pyatlan.model.typedef
1014

15+
## Audit
16+
17+
::: pyatlan.model.audit
18+
19+
## Lineage
20+
21+
::: pyatlan.model.lineage
22+
23+
## Custom Metadata
24+
25+
::: pyatlan.model.custom_metadata
26+
27+
## Structs
28+
29+
::: pyatlan.model.structs
30+
31+
## Enums
32+
33+
::: pyatlan.model.enums
34+
1135
## Packages
1236

1337
::: pyatlan.model.packages
38+
39+
## Group
40+
41+
::: pyatlan.model.group
42+
43+
## Role
44+
45+
::: pyatlan.model.role
46+
47+
## User
48+
49+
::: pyatlan.model.user
50+
51+
## Task
52+
53+
::: pyatlan.model.task
54+
55+
## Workflow
56+
57+
::: pyatlan.model.workflow
58+
59+
## Query
60+
61+
::: pyatlan.model.query
62+
63+
## Response
64+
65+
::: pyatlan.model.response
66+
67+
## Contract
68+
69+
::: pyatlan.model.contract
70+
71+
## Credential
72+
73+
::: pyatlan.model.credential
74+
75+
## SSO
76+
77+
::: pyatlan.model.sso
78+
79+
## API Tokens
80+
81+
::: pyatlan.model.api_tokens
82+
83+
## Aggregation
84+
85+
::: pyatlan.model.aggregation
86+
87+
## Events
88+
89+
::: pyatlan.model.events
90+
91+
## Keycloak Events
92+
93+
::: pyatlan.model.keycloak_events
94+
95+
## Suggestions
96+
97+
::: pyatlan.model.suggestions
98+
99+
## Search Log
100+
101+
::: pyatlan.model.search_log
102+
103+
## Data Mesh
104+
105+
::: pyatlan.model.data_mesh
106+
107+
## File
108+
109+
::: pyatlan.model.file
110+
111+
## Fluent Tasks
112+
113+
::: pyatlan.model.fluent_tasks
114+
115+
## Lineage Ref
116+
117+
::: pyatlan.model.lineage_ref

0 commit comments

Comments
 (0)