Skip to content

Commit 329dab3

Browse files
Aryamanz29claude
andcommitted
docs: add cache, events, and asset model pages
- Fix cache.md to reference individual cache classes (AtlanTagCache, CustomMetadataCache, EnumCache, GroupCache, RoleCache, UserCache, ConnectionCache, SourceTagCache) instead of empty package directive - Fix events.md to reference AtlanEventHandler class directly - Add assets.md with core base classes, SQL, Glossary, BI, Data Mesh, Access Control, and Resource asset types - Add Asset Models page to mkdocs.yml nav Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a730c9e commit 329dab3

5 files changed

Lines changed: 109 additions & 2 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,4 @@ pyatlan/documentation/*.md
5959
# Sphinx
6060
docs/_build/
6161
docs/generated/
62+
site/

docs/api/assets.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Asset Models
2+
3+
All Atlan asset types are available in `pyatlan.model.assets`.
4+
5+
## Core Base Classes
6+
7+
::: pyatlan.model.assets.core.referenceable.Referenceable
8+
9+
::: pyatlan.model.assets.core.asset.Asset
10+
11+
::: pyatlan.model.assets.core.catalog.Catalog
12+
13+
::: pyatlan.model.assets.core.process.Process
14+
15+
## SQL Assets
16+
17+
::: pyatlan.model.assets.core.s_q_l.SQL
18+
19+
::: pyatlan.model.assets.core.database.Database
20+
21+
::: pyatlan.model.assets.core.schema.Schema
22+
23+
::: pyatlan.model.assets.core.table.Table
24+
25+
::: pyatlan.model.assets.core.view.View
26+
27+
::: pyatlan.model.assets.core.materialised_view.MaterialisedView
28+
29+
::: pyatlan.model.assets.core.column.Column
30+
31+
## Glossary
32+
33+
::: pyatlan.model.assets.core.atlas_glossary.AtlasGlossary
34+
35+
::: pyatlan.model.assets.core.atlas_glossary_term.AtlasGlossaryTerm
36+
37+
::: pyatlan.model.assets.core.atlas_glossary_category.AtlasGlossaryCategory
38+
39+
## Data Mesh
40+
41+
::: pyatlan.model.assets.core.data_domain.DataDomain
42+
43+
::: pyatlan.model.assets.core.data_product.DataProduct
44+
45+
## BI
46+
47+
::: pyatlan.model.assets.core.b_i.BI
48+
49+
::: pyatlan.model.assets.core.power_b_i.PowerBI
50+
51+
::: pyatlan.model.assets.core.fabric.Fabric
52+
53+
## Access Control
54+
55+
::: pyatlan.model.assets.core.access_control.AccessControl
56+
57+
::: pyatlan.model.assets.core.persona.Persona
58+
59+
::: pyatlan.model.assets.core.auth_policy.AuthPolicy
60+
61+
## Resources
62+
63+
::: pyatlan.model.assets.core.resource.Resource
64+
65+
::: pyatlan.model.assets.core.link.Link
66+
67+
::: pyatlan.model.assets.core.readme.Readme
68+
69+
::: pyatlan.model.assets.core.file.File

docs/api/cache.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# Cache
22

3-
::: pyatlan.cache
3+
## AtlanTagCache
4+
5+
::: pyatlan.cache.atlan_tag_cache.AtlanTagCache
6+
7+
## CustomMetadataCache
8+
9+
::: pyatlan.cache.custom_metadata_cache.CustomMetadataCache
10+
11+
## EnumCache
12+
13+
::: pyatlan.cache.enum_cache.EnumCache
14+
15+
## GroupCache
16+
17+
::: pyatlan.cache.group_cache.GroupCache
18+
19+
## RoleCache
20+
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

docs/api/events.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Events
22

3-
::: pyatlan.events
3+
## AtlanEventHandler
4+
5+
::: pyatlan.events.atlan_event_handler.AtlanEventHandler
6+
7+
## AtlanLambdaHandler
8+
9+
::: pyatlan.events.atlan_lambda_handler

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ nav:
4646
- Home: index.md
4747
- API Reference:
4848
- AtlanClient: api/client.md
49+
- Asset Models: api/assets.md
4950
- Models: api/model.md
5051
- Cache: api/cache.md
5152
- Events: api/events.md

0 commit comments

Comments
 (0)