From b5edbd60d226e5184279f18c98205fed9779f3db Mon Sep 17 00:00:00 2001 From: Christopher Grote Date: Tue, 19 Sep 2023 12:00:48 +0100 Subject: [PATCH] Initial Sphinx-based doc generation Signed-off-by: Christopher Grote --- .gitignore | 5 + docs/Makefile | 20 ++ docs/asset/accesscontrol.rst | 10 + docs/asset/adls.rst | 10 + docs/asset/adlsaccount.rst | 10 + docs/asset/adlscontainer.rst | 10 + docs/asset/adlsobject.rst | 10 + docs/asset/airflow.rst | 10 + docs/asset/airflowdag.rst | 10 + docs/asset/airflowtask.rst | 10 + docs/asset/api.rst | 10 + docs/asset/apipath.rst | 10 + docs/asset/apispec.rst | 10 + docs/asset/asset.rst | 10 + docs/asset/atlasglossary.rst | 10 + docs/asset/atlasglossarycategory.rst | 10 + docs/asset/atlasglossaryterm.rst | 10 + docs/asset/atlasserver.rst | 10 + docs/asset/authpolicy.rst | 10 + docs/asset/authservice.rst | 10 + docs/asset/aws.rst | 10 + docs/asset/azure.rst | 10 + docs/asset/azureeventhub.rst | 10 + docs/asset/azureeventhubconsumergroup.rst | 10 + docs/asset/badge.rst | 10 + docs/asset/bi.rst | 10 + docs/asset/biprocess.rst | 10 + docs/asset/catalog.rst | 10 + docs/asset/cloud.rst | 10 + docs/asset/collection.rst | 10 + docs/asset/column.rst | 10 + docs/asset/columnprocess.rst | 10 + docs/asset/connection.rst | 10 + docs/asset/database.rst | 10 + docs/asset/dataquality.rst | 10 + docs/asset/dataset.rst | 10 + docs/asset/datastudio.rst | 10 + docs/asset/datastudioasset.rst | 10 + docs/asset/dbt.rst | 10 + docs/asset/dbtcolumnprocess.rst | 10 + docs/asset/dbtmetric.rst | 10 + docs/asset/dbtmodel.rst | 10 + docs/asset/dbtmodelcolumn.rst | 10 + docs/asset/dbtprocess.rst | 10 + docs/asset/dbtsource.rst | 10 + docs/asset/dbttag.rst | 10 + docs/asset/dbttest.rst | 10 + docs/asset/eventstore.rst | 10 + docs/asset/file.rst | 10 + docs/asset/folder.rst | 10 + docs/asset/function.rst | 10 + docs/asset/gcs.rst | 10 + docs/asset/gcsbucket.rst | 10 + docs/asset/gcsobject.rst | 10 + docs/asset/google.rst | 10 + docs/asset/infrastructure.rst | 10 + docs/asset/insight.rst | 10 + docs/asset/kafka.rst | 10 + docs/asset/kafkaconsumergroup.rst | 10 + docs/asset/kafkatopic.rst | 10 + docs/asset/link.rst | 10 + docs/asset/looker.rst | 10 + docs/asset/lookerdashboard.rst | 10 + docs/asset/lookerexplore.rst | 10 + docs/asset/lookerfield.rst | 10 + docs/asset/lookerfolder.rst | 10 + docs/asset/lookerlook.rst | 10 + docs/asset/lookermodel.rst | 10 + docs/asset/lookerproject.rst | 10 + docs/asset/lookerquery.rst | 10 + docs/asset/lookertile.rst | 10 + docs/asset/lookerview.rst | 10 + docs/asset/materialisedview.rst | 10 + docs/asset/matillion.rst | 10 + docs/asset/matillioncomponent.rst | 10 + docs/asset/matilliongroup.rst | 10 + docs/asset/matillionjob.rst | 10 + docs/asset/matillionproject.rst | 10 + docs/asset/mcincident.rst | 10 + docs/asset/mcmonitor.rst | 10 + docs/asset/metabase.rst | 10 + docs/asset/metabasecollection.rst | 10 + docs/asset/metabasedashboard.rst | 10 + docs/asset/metabasequestion.rst | 10 + docs/asset/metric.rst | 10 + docs/asset/microstrategy.rst | 10 + docs/asset/microstrategyattribute.rst | 10 + docs/asset/microstrategycube.rst | 10 + docs/asset/microstrategydocument.rst | 10 + docs/asset/microstrategydossier.rst | 10 + docs/asset/microstrategyfact.rst | 10 + docs/asset/microstrategymetric.rst | 10 + docs/asset/microstrategyproject.rst | 10 + docs/asset/microstrategyreport.rst | 10 + docs/asset/microstrategyvisualization.rst | 10 + docs/asset/mode.rst | 10 + docs/asset/modechart.rst | 10 + docs/asset/modecollection.rst | 10 + docs/asset/modequery.rst | 10 + docs/asset/modereport.rst | 10 + docs/asset/modeworkspace.rst | 10 + docs/asset/mongodb.rst | 10 + docs/asset/mongodbcollection.rst | 10 + docs/asset/mongodbdatabase.rst | 10 + docs/asset/montecarlo.rst | 10 + docs/asset/namespace.rst | 10 + docs/asset/nosql.rst | 10 + docs/asset/objectstore.rst | 10 + docs/asset/persona.rst | 10 + docs/asset/powerbi.rst | 10 + docs/asset/powerbicolumn.rst | 10 + docs/asset/powerbidashboard.rst | 10 + docs/asset/powerbidataflow.rst | 10 + docs/asset/powerbidataset.rst | 10 + docs/asset/powerbidatasource.rst | 10 + docs/asset/powerbimeasure.rst | 10 + docs/asset/powerbipage.rst | 10 + docs/asset/powerbireport.rst | 10 + docs/asset/powerbitable.rst | 10 + docs/asset/powerbitile.rst | 10 + docs/asset/powerbiworkspace.rst | 10 + docs/asset/preset.rst | 10 + docs/asset/presetchart.rst | 10 + docs/asset/presetdashboard.rst | 10 + docs/asset/presetdataset.rst | 10 + docs/asset/presetworkspace.rst | 10 + docs/asset/procedure.rst | 10 + docs/asset/process.rst | 10 + docs/asset/processexecution.rst | 10 + docs/asset/purpose.rst | 10 + docs/asset/qlik.rst | 10 + docs/asset/qlikapp.rst | 10 + docs/asset/qlikchart.rst | 10 + docs/asset/qlikdataset.rst | 10 + docs/asset/qliksheet.rst | 10 + docs/asset/qlikspace.rst | 10 + docs/asset/qlikstream.rst | 10 + docs/asset/query.rst | 10 + docs/asset/quicksight.rst | 10 + docs/asset/quicksightanalysis.rst | 10 + docs/asset/quicksightanalysisvisual.rst | 10 + docs/asset/quicksightdashboard.rst | 10 + docs/asset/quicksightdashboardvisual.rst | 10 + docs/asset/quicksightdataset.rst | 10 + docs/asset/quicksightdatasetfield.rst | 10 + docs/asset/quicksightfolder.rst | 10 + docs/asset/readme.rst | 10 + docs/asset/readmetemplate.rst | 10 + docs/asset/redash.rst | 10 + docs/asset/redashdashboard.rst | 10 + docs/asset/redashquery.rst | 10 + docs/asset/redashvisualization.rst | 10 + docs/asset/referenceable.rst | 10 + docs/asset/resource.rst | 10 + docs/asset/s3.rst | 10 + docs/asset/s3bucket.rst | 10 + docs/asset/s3object.rst | 10 + docs/asset/saas.rst | 10 + docs/asset/salesforce.rst | 10 + docs/asset/salesforcedashboard.rst | 10 + docs/asset/salesforcefield.rst | 10 + docs/asset/salesforceobject.rst | 10 + docs/asset/salesforceorganization.rst | 10 + docs/asset/salesforcereport.rst | 10 + docs/asset/schema.rst | 10 + docs/asset/schemaregistry.rst | 10 + docs/asset/schemaregistrysubject.rst | 10 + docs/asset/sigma.rst | 10 + docs/asset/sigmadataelement.rst | 10 + docs/asset/sigmadataelementfield.rst | 10 + docs/asset/sigmadataset.rst | 10 + docs/asset/sigmadatasetcolumn.rst | 10 + docs/asset/sigmapage.rst | 10 + docs/asset/sigmaworkbook.rst | 10 + docs/asset/snowflakedynamictable.rst | 10 + docs/asset/snowflakepipe.rst | 10 + docs/asset/snowflakestream.rst | 10 + docs/asset/snowflaketag.rst | 10 + docs/asset/soda.rst | 10 + docs/asset/sodacheck.rst | 10 + docs/asset/sql.rst | 10 + docs/asset/table.rst | 10 + docs/asset/tableau.rst | 10 + docs/asset/tableaucalculatedfield.rst | 10 + docs/asset/tableaudashboard.rst | 10 + docs/asset/tableaudatasource.rst | 10 + docs/asset/tableaudatasourcefield.rst | 10 + docs/asset/tableauflow.rst | 10 + docs/asset/tableaumetric.rst | 10 + docs/asset/tableauproject.rst | 10 + docs/asset/tableausite.rst | 10 + docs/asset/tableauworkbook.rst | 10 + docs/asset/tableauworksheet.rst | 10 + docs/asset/tablepartition.rst | 10 + docs/asset/tag.rst | 10 + docs/asset/thoughtspot.rst | 10 + docs/asset/thoughtspotanswer.rst | 10 + docs/asset/thoughtspotdashlet.rst | 10 + docs/asset/thoughtspotliveboard.rst | 10 + docs/asset/view.rst | 10 + docs/assets.rst | 208 ++++++++++++++++++ docs/cache/atlan_tag_cache.rst | 10 + docs/cache/custom_metadata_cache.rst | 10 + docs/cache/enum_cache.rst | 10 + docs/cache/group_cache.rst | 10 + docs/cache/role_cache.rst | 10 + docs/cache/user_cache.rst | 10 + docs/caches.rst | 16 ++ docs/client.rst | 13 ++ docs/conf.py | 41 ++++ docs/events.rst | 17 ++ docs/exceptions.rst | 20 ++ docs/field/boolean_field.rst | 10 + docs/field/custom_metadata_field.rst | 10 + docs/field/keyword_field.rst | 10 + docs/field/keyword_text_field.rst | 10 + docs/field/keyword_text_stemmed_field.rst | 10 + docs/field/numeric_field.rst | 10 + docs/field/numeric_rank_field.rst | 10 + docs/field/relation_field.rst | 10 + docs/field/searchable_field.rst | 10 + docs/field/text_field.rst | 10 + docs/fields.rst | 31 +++ docs/index.rst | 26 +++ docs/other_model/atlan_image.rst | 10 + docs/other_model/core.rst | 31 +++ docs/other_model/custom_metadata.rst | 16 ++ docs/other_model/group.rst | 10 + docs/other_model/keycloak_events.rst | 13 ++ docs/other_model/lineage.rst | 25 +++ docs/other_model/role.rst | 10 + docs/other_model/typedef.rst | 37 ++++ docs/other_model/user.rst | 10 + docs/other_models.rst | 19 ++ pyatlan/generator/class_generator.py | 31 +++ .../documentation/sphinx_asset.jinja2 | 10 + .../documentation/sphinx_asset_index.jinja2 | 12 + requirements-dev.txt | 1 + 238 files changed, 2772 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/asset/accesscontrol.rst create mode 100644 docs/asset/adls.rst create mode 100644 docs/asset/adlsaccount.rst create mode 100644 docs/asset/adlscontainer.rst create mode 100644 docs/asset/adlsobject.rst create mode 100644 docs/asset/airflow.rst create mode 100644 docs/asset/airflowdag.rst create mode 100644 docs/asset/airflowtask.rst create mode 100644 docs/asset/api.rst create mode 100644 docs/asset/apipath.rst create mode 100644 docs/asset/apispec.rst create mode 100644 docs/asset/asset.rst create mode 100644 docs/asset/atlasglossary.rst create mode 100644 docs/asset/atlasglossarycategory.rst create mode 100644 docs/asset/atlasglossaryterm.rst create mode 100644 docs/asset/atlasserver.rst create mode 100644 docs/asset/authpolicy.rst create mode 100644 docs/asset/authservice.rst create mode 100644 docs/asset/aws.rst create mode 100644 docs/asset/azure.rst create mode 100644 docs/asset/azureeventhub.rst create mode 100644 docs/asset/azureeventhubconsumergroup.rst create mode 100644 docs/asset/badge.rst create mode 100644 docs/asset/bi.rst create mode 100644 docs/asset/biprocess.rst create mode 100644 docs/asset/catalog.rst create mode 100644 docs/asset/cloud.rst create mode 100644 docs/asset/collection.rst create mode 100644 docs/asset/column.rst create mode 100644 docs/asset/columnprocess.rst create mode 100644 docs/asset/connection.rst create mode 100644 docs/asset/database.rst create mode 100644 docs/asset/dataquality.rst create mode 100644 docs/asset/dataset.rst create mode 100644 docs/asset/datastudio.rst create mode 100644 docs/asset/datastudioasset.rst create mode 100644 docs/asset/dbt.rst create mode 100644 docs/asset/dbtcolumnprocess.rst create mode 100644 docs/asset/dbtmetric.rst create mode 100644 docs/asset/dbtmodel.rst create mode 100644 docs/asset/dbtmodelcolumn.rst create mode 100644 docs/asset/dbtprocess.rst create mode 100644 docs/asset/dbtsource.rst create mode 100644 docs/asset/dbttag.rst create mode 100644 docs/asset/dbttest.rst create mode 100644 docs/asset/eventstore.rst create mode 100644 docs/asset/file.rst create mode 100644 docs/asset/folder.rst create mode 100644 docs/asset/function.rst create mode 100644 docs/asset/gcs.rst create mode 100644 docs/asset/gcsbucket.rst create mode 100644 docs/asset/gcsobject.rst create mode 100644 docs/asset/google.rst create mode 100644 docs/asset/infrastructure.rst create mode 100644 docs/asset/insight.rst create mode 100644 docs/asset/kafka.rst create mode 100644 docs/asset/kafkaconsumergroup.rst create mode 100644 docs/asset/kafkatopic.rst create mode 100644 docs/asset/link.rst create mode 100644 docs/asset/looker.rst create mode 100644 docs/asset/lookerdashboard.rst create mode 100644 docs/asset/lookerexplore.rst create mode 100644 docs/asset/lookerfield.rst create mode 100644 docs/asset/lookerfolder.rst create mode 100644 docs/asset/lookerlook.rst create mode 100644 docs/asset/lookermodel.rst create mode 100644 docs/asset/lookerproject.rst create mode 100644 docs/asset/lookerquery.rst create mode 100644 docs/asset/lookertile.rst create mode 100644 docs/asset/lookerview.rst create mode 100644 docs/asset/materialisedview.rst create mode 100644 docs/asset/matillion.rst create mode 100644 docs/asset/matillioncomponent.rst create mode 100644 docs/asset/matilliongroup.rst create mode 100644 docs/asset/matillionjob.rst create mode 100644 docs/asset/matillionproject.rst create mode 100644 docs/asset/mcincident.rst create mode 100644 docs/asset/mcmonitor.rst create mode 100644 docs/asset/metabase.rst create mode 100644 docs/asset/metabasecollection.rst create mode 100644 docs/asset/metabasedashboard.rst create mode 100644 docs/asset/metabasequestion.rst create mode 100644 docs/asset/metric.rst create mode 100644 docs/asset/microstrategy.rst create mode 100644 docs/asset/microstrategyattribute.rst create mode 100644 docs/asset/microstrategycube.rst create mode 100644 docs/asset/microstrategydocument.rst create mode 100644 docs/asset/microstrategydossier.rst create mode 100644 docs/asset/microstrategyfact.rst create mode 100644 docs/asset/microstrategymetric.rst create mode 100644 docs/asset/microstrategyproject.rst create mode 100644 docs/asset/microstrategyreport.rst create mode 100644 docs/asset/microstrategyvisualization.rst create mode 100644 docs/asset/mode.rst create mode 100644 docs/asset/modechart.rst create mode 100644 docs/asset/modecollection.rst create mode 100644 docs/asset/modequery.rst create mode 100644 docs/asset/modereport.rst create mode 100644 docs/asset/modeworkspace.rst create mode 100644 docs/asset/mongodb.rst create mode 100644 docs/asset/mongodbcollection.rst create mode 100644 docs/asset/mongodbdatabase.rst create mode 100644 docs/asset/montecarlo.rst create mode 100644 docs/asset/namespace.rst create mode 100644 docs/asset/nosql.rst create mode 100644 docs/asset/objectstore.rst create mode 100644 docs/asset/persona.rst create mode 100644 docs/asset/powerbi.rst create mode 100644 docs/asset/powerbicolumn.rst create mode 100644 docs/asset/powerbidashboard.rst create mode 100644 docs/asset/powerbidataflow.rst create mode 100644 docs/asset/powerbidataset.rst create mode 100644 docs/asset/powerbidatasource.rst create mode 100644 docs/asset/powerbimeasure.rst create mode 100644 docs/asset/powerbipage.rst create mode 100644 docs/asset/powerbireport.rst create mode 100644 docs/asset/powerbitable.rst create mode 100644 docs/asset/powerbitile.rst create mode 100644 docs/asset/powerbiworkspace.rst create mode 100644 docs/asset/preset.rst create mode 100644 docs/asset/presetchart.rst create mode 100644 docs/asset/presetdashboard.rst create mode 100644 docs/asset/presetdataset.rst create mode 100644 docs/asset/presetworkspace.rst create mode 100644 docs/asset/procedure.rst create mode 100644 docs/asset/process.rst create mode 100644 docs/asset/processexecution.rst create mode 100644 docs/asset/purpose.rst create mode 100644 docs/asset/qlik.rst create mode 100644 docs/asset/qlikapp.rst create mode 100644 docs/asset/qlikchart.rst create mode 100644 docs/asset/qlikdataset.rst create mode 100644 docs/asset/qliksheet.rst create mode 100644 docs/asset/qlikspace.rst create mode 100644 docs/asset/qlikstream.rst create mode 100644 docs/asset/query.rst create mode 100644 docs/asset/quicksight.rst create mode 100644 docs/asset/quicksightanalysis.rst create mode 100644 docs/asset/quicksightanalysisvisual.rst create mode 100644 docs/asset/quicksightdashboard.rst create mode 100644 docs/asset/quicksightdashboardvisual.rst create mode 100644 docs/asset/quicksightdataset.rst create mode 100644 docs/asset/quicksightdatasetfield.rst create mode 100644 docs/asset/quicksightfolder.rst create mode 100644 docs/asset/readme.rst create mode 100644 docs/asset/readmetemplate.rst create mode 100644 docs/asset/redash.rst create mode 100644 docs/asset/redashdashboard.rst create mode 100644 docs/asset/redashquery.rst create mode 100644 docs/asset/redashvisualization.rst create mode 100644 docs/asset/referenceable.rst create mode 100644 docs/asset/resource.rst create mode 100644 docs/asset/s3.rst create mode 100644 docs/asset/s3bucket.rst create mode 100644 docs/asset/s3object.rst create mode 100644 docs/asset/saas.rst create mode 100644 docs/asset/salesforce.rst create mode 100644 docs/asset/salesforcedashboard.rst create mode 100644 docs/asset/salesforcefield.rst create mode 100644 docs/asset/salesforceobject.rst create mode 100644 docs/asset/salesforceorganization.rst create mode 100644 docs/asset/salesforcereport.rst create mode 100644 docs/asset/schema.rst create mode 100644 docs/asset/schemaregistry.rst create mode 100644 docs/asset/schemaregistrysubject.rst create mode 100644 docs/asset/sigma.rst create mode 100644 docs/asset/sigmadataelement.rst create mode 100644 docs/asset/sigmadataelementfield.rst create mode 100644 docs/asset/sigmadataset.rst create mode 100644 docs/asset/sigmadatasetcolumn.rst create mode 100644 docs/asset/sigmapage.rst create mode 100644 docs/asset/sigmaworkbook.rst create mode 100644 docs/asset/snowflakedynamictable.rst create mode 100644 docs/asset/snowflakepipe.rst create mode 100644 docs/asset/snowflakestream.rst create mode 100644 docs/asset/snowflaketag.rst create mode 100644 docs/asset/soda.rst create mode 100644 docs/asset/sodacheck.rst create mode 100644 docs/asset/sql.rst create mode 100644 docs/asset/table.rst create mode 100644 docs/asset/tableau.rst create mode 100644 docs/asset/tableaucalculatedfield.rst create mode 100644 docs/asset/tableaudashboard.rst create mode 100644 docs/asset/tableaudatasource.rst create mode 100644 docs/asset/tableaudatasourcefield.rst create mode 100644 docs/asset/tableauflow.rst create mode 100644 docs/asset/tableaumetric.rst create mode 100644 docs/asset/tableauproject.rst create mode 100644 docs/asset/tableausite.rst create mode 100644 docs/asset/tableauworkbook.rst create mode 100644 docs/asset/tableauworksheet.rst create mode 100644 docs/asset/tablepartition.rst create mode 100644 docs/asset/tag.rst create mode 100644 docs/asset/thoughtspot.rst create mode 100644 docs/asset/thoughtspotanswer.rst create mode 100644 docs/asset/thoughtspotdashlet.rst create mode 100644 docs/asset/thoughtspotliveboard.rst create mode 100644 docs/asset/view.rst create mode 100644 docs/assets.rst create mode 100644 docs/cache/atlan_tag_cache.rst create mode 100644 docs/cache/custom_metadata_cache.rst create mode 100644 docs/cache/enum_cache.rst create mode 100644 docs/cache/group_cache.rst create mode 100644 docs/cache/role_cache.rst create mode 100644 docs/cache/user_cache.rst create mode 100644 docs/caches.rst create mode 100644 docs/client.rst create mode 100644 docs/conf.py create mode 100644 docs/events.rst create mode 100644 docs/exceptions.rst create mode 100644 docs/field/boolean_field.rst create mode 100644 docs/field/custom_metadata_field.rst create mode 100644 docs/field/keyword_field.rst create mode 100644 docs/field/keyword_text_field.rst create mode 100644 docs/field/keyword_text_stemmed_field.rst create mode 100644 docs/field/numeric_field.rst create mode 100644 docs/field/numeric_rank_field.rst create mode 100644 docs/field/relation_field.rst create mode 100644 docs/field/searchable_field.rst create mode 100644 docs/field/text_field.rst create mode 100644 docs/fields.rst create mode 100644 docs/index.rst create mode 100644 docs/other_model/atlan_image.rst create mode 100644 docs/other_model/core.rst create mode 100644 docs/other_model/custom_metadata.rst create mode 100644 docs/other_model/group.rst create mode 100644 docs/other_model/keycloak_events.rst create mode 100644 docs/other_model/lineage.rst create mode 100644 docs/other_model/role.rst create mode 100644 docs/other_model/typedef.rst create mode 100644 docs/other_model/user.rst create mode 100644 docs/other_models.rst create mode 100644 pyatlan/generator/templates/documentation/sphinx_asset.jinja2 create mode 100644 pyatlan/generator/templates/documentation/sphinx_asset_index.jinja2 diff --git a/.gitignore b/.gitignore index dbd364958..aca3def21 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .idea/ +.vscode/ # dotenv .env @@ -54,3 +55,7 @@ examples/ # Generated documentation pyatlan/documentation/*.md + +# Sphinx +docs/_build/ +docs/generated/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..d4bb2cbb9 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/asset/accesscontrol.rst b/docs/asset/accesscontrol.rst new file mode 100644 index 000000000..d81aac4d2 --- /dev/null +++ b/docs/asset/accesscontrol.rst @@ -0,0 +1,10 @@ +.. _accesscontrol: + +AccessControl +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AccessControl + :members: diff --git a/docs/asset/adls.rst b/docs/asset/adls.rst new file mode 100644 index 000000000..405590cda --- /dev/null +++ b/docs/asset/adls.rst @@ -0,0 +1,10 @@ +.. _adls: + +ADLS +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ADLS + :members: diff --git a/docs/asset/adlsaccount.rst b/docs/asset/adlsaccount.rst new file mode 100644 index 000000000..55f8aff04 --- /dev/null +++ b/docs/asset/adlsaccount.rst @@ -0,0 +1,10 @@ +.. _adlsaccount: + +ADLSAccount +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ADLSAccount + :members: diff --git a/docs/asset/adlscontainer.rst b/docs/asset/adlscontainer.rst new file mode 100644 index 000000000..7dc56d0b3 --- /dev/null +++ b/docs/asset/adlscontainer.rst @@ -0,0 +1,10 @@ +.. _adlscontainer: + +ADLSContainer +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ADLSContainer + :members: diff --git a/docs/asset/adlsobject.rst b/docs/asset/adlsobject.rst new file mode 100644 index 000000000..16e0cdb38 --- /dev/null +++ b/docs/asset/adlsobject.rst @@ -0,0 +1,10 @@ +.. _adlsobject: + +ADLSObject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ADLSObject + :members: diff --git a/docs/asset/airflow.rst b/docs/asset/airflow.rst new file mode 100644 index 000000000..0555b33c1 --- /dev/null +++ b/docs/asset/airflow.rst @@ -0,0 +1,10 @@ +.. _airflow: + +Airflow +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Airflow + :members: diff --git a/docs/asset/airflowdag.rst b/docs/asset/airflowdag.rst new file mode 100644 index 000000000..a89d712c5 --- /dev/null +++ b/docs/asset/airflowdag.rst @@ -0,0 +1,10 @@ +.. _airflowdag: + +AirflowDag +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AirflowDag + :members: diff --git a/docs/asset/airflowtask.rst b/docs/asset/airflowtask.rst new file mode 100644 index 000000000..8e598afcc --- /dev/null +++ b/docs/asset/airflowtask.rst @@ -0,0 +1,10 @@ +.. _airflowtask: + +AirflowTask +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AirflowTask + :members: diff --git a/docs/asset/api.rst b/docs/asset/api.rst new file mode 100644 index 000000000..102f65a9a --- /dev/null +++ b/docs/asset/api.rst @@ -0,0 +1,10 @@ +.. _api: + +API +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: API + :members: diff --git a/docs/asset/apipath.rst b/docs/asset/apipath.rst new file mode 100644 index 000000000..18f0ca30d --- /dev/null +++ b/docs/asset/apipath.rst @@ -0,0 +1,10 @@ +.. _apipath: + +APIPath +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: APIPath + :members: diff --git a/docs/asset/apispec.rst b/docs/asset/apispec.rst new file mode 100644 index 000000000..48ba5f7cc --- /dev/null +++ b/docs/asset/apispec.rst @@ -0,0 +1,10 @@ +.. _apispec: + +APISpec +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: APISpec + :members: diff --git a/docs/asset/asset.rst b/docs/asset/asset.rst new file mode 100644 index 000000000..24e26dbfc --- /dev/null +++ b/docs/asset/asset.rst @@ -0,0 +1,10 @@ +.. _asset: + +Asset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Asset + :members: diff --git a/docs/asset/atlasglossary.rst b/docs/asset/atlasglossary.rst new file mode 100644 index 000000000..9505c591c --- /dev/null +++ b/docs/asset/atlasglossary.rst @@ -0,0 +1,10 @@ +.. _atlasglossary: + +AtlasGlossary +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AtlasGlossary + :members: diff --git a/docs/asset/atlasglossarycategory.rst b/docs/asset/atlasglossarycategory.rst new file mode 100644 index 000000000..e4ba3b773 --- /dev/null +++ b/docs/asset/atlasglossarycategory.rst @@ -0,0 +1,10 @@ +.. _atlasglossarycategory: + +AtlasGlossaryCategory +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AtlasGlossaryCategory + :members: diff --git a/docs/asset/atlasglossaryterm.rst b/docs/asset/atlasglossaryterm.rst new file mode 100644 index 000000000..8fc65af0b --- /dev/null +++ b/docs/asset/atlasglossaryterm.rst @@ -0,0 +1,10 @@ +.. _atlasglossaryterm: + +AtlasGlossaryTerm +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AtlasGlossaryTerm + :members: diff --git a/docs/asset/atlasserver.rst b/docs/asset/atlasserver.rst new file mode 100644 index 000000000..74e90bdd6 --- /dev/null +++ b/docs/asset/atlasserver.rst @@ -0,0 +1,10 @@ +.. _atlasserver: + +AtlasServer +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AtlasServer + :members: diff --git a/docs/asset/authpolicy.rst b/docs/asset/authpolicy.rst new file mode 100644 index 000000000..91f3f67a2 --- /dev/null +++ b/docs/asset/authpolicy.rst @@ -0,0 +1,10 @@ +.. _authpolicy: + +AuthPolicy +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AuthPolicy + :members: diff --git a/docs/asset/authservice.rst b/docs/asset/authservice.rst new file mode 100644 index 000000000..83be55f3b --- /dev/null +++ b/docs/asset/authservice.rst @@ -0,0 +1,10 @@ +.. _authservice: + +AuthService +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AuthService + :members: diff --git a/docs/asset/aws.rst b/docs/asset/aws.rst new file mode 100644 index 000000000..1f950f6da --- /dev/null +++ b/docs/asset/aws.rst @@ -0,0 +1,10 @@ +.. _aws: + +AWS +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AWS + :members: diff --git a/docs/asset/azure.rst b/docs/asset/azure.rst new file mode 100644 index 000000000..bfdf4c157 --- /dev/null +++ b/docs/asset/azure.rst @@ -0,0 +1,10 @@ +.. _azure: + +Azure +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Azure + :members: diff --git a/docs/asset/azureeventhub.rst b/docs/asset/azureeventhub.rst new file mode 100644 index 000000000..df08e6b81 --- /dev/null +++ b/docs/asset/azureeventhub.rst @@ -0,0 +1,10 @@ +.. _azureeventhub: + +AzureEventHub +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AzureEventHub + :members: diff --git a/docs/asset/azureeventhubconsumergroup.rst b/docs/asset/azureeventhubconsumergroup.rst new file mode 100644 index 000000000..4379c1fe6 --- /dev/null +++ b/docs/asset/azureeventhubconsumergroup.rst @@ -0,0 +1,10 @@ +.. _azureeventhubconsumergroup: + +AzureEventHubConsumerGroup +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: AzureEventHubConsumerGroup + :members: diff --git a/docs/asset/badge.rst b/docs/asset/badge.rst new file mode 100644 index 000000000..266dceb90 --- /dev/null +++ b/docs/asset/badge.rst @@ -0,0 +1,10 @@ +.. _badge: + +Badge +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Badge + :members: diff --git a/docs/asset/bi.rst b/docs/asset/bi.rst new file mode 100644 index 000000000..40135ded1 --- /dev/null +++ b/docs/asset/bi.rst @@ -0,0 +1,10 @@ +.. _bi: + +BI +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: BI + :members: diff --git a/docs/asset/biprocess.rst b/docs/asset/biprocess.rst new file mode 100644 index 000000000..ad184dc5a --- /dev/null +++ b/docs/asset/biprocess.rst @@ -0,0 +1,10 @@ +.. _biprocess: + +BIProcess +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: BIProcess + :members: diff --git a/docs/asset/catalog.rst b/docs/asset/catalog.rst new file mode 100644 index 000000000..8d6b5052e --- /dev/null +++ b/docs/asset/catalog.rst @@ -0,0 +1,10 @@ +.. _catalog: + +Catalog +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Catalog + :members: diff --git a/docs/asset/cloud.rst b/docs/asset/cloud.rst new file mode 100644 index 000000000..4ac88923e --- /dev/null +++ b/docs/asset/cloud.rst @@ -0,0 +1,10 @@ +.. _cloud: + +Cloud +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Cloud + :members: diff --git a/docs/asset/collection.rst b/docs/asset/collection.rst new file mode 100644 index 000000000..088a2eb98 --- /dev/null +++ b/docs/asset/collection.rst @@ -0,0 +1,10 @@ +.. _collection: + +Collection +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Collection + :members: diff --git a/docs/asset/column.rst b/docs/asset/column.rst new file mode 100644 index 000000000..333fbb394 --- /dev/null +++ b/docs/asset/column.rst @@ -0,0 +1,10 @@ +.. _column: + +Column +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Column + :members: diff --git a/docs/asset/columnprocess.rst b/docs/asset/columnprocess.rst new file mode 100644 index 000000000..2683a8ae9 --- /dev/null +++ b/docs/asset/columnprocess.rst @@ -0,0 +1,10 @@ +.. _columnprocess: + +ColumnProcess +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ColumnProcess + :members: diff --git a/docs/asset/connection.rst b/docs/asset/connection.rst new file mode 100644 index 000000000..156606226 --- /dev/null +++ b/docs/asset/connection.rst @@ -0,0 +1,10 @@ +.. _connection: + +Connection +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Connection + :members: diff --git a/docs/asset/database.rst b/docs/asset/database.rst new file mode 100644 index 000000000..de7711098 --- /dev/null +++ b/docs/asset/database.rst @@ -0,0 +1,10 @@ +.. _database: + +Database +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Database + :members: diff --git a/docs/asset/dataquality.rst b/docs/asset/dataquality.rst new file mode 100644 index 000000000..ce3084997 --- /dev/null +++ b/docs/asset/dataquality.rst @@ -0,0 +1,10 @@ +.. _dataquality: + +DataQuality +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DataQuality + :members: diff --git a/docs/asset/dataset.rst b/docs/asset/dataset.rst new file mode 100644 index 000000000..eb2a95bb6 --- /dev/null +++ b/docs/asset/dataset.rst @@ -0,0 +1,10 @@ +.. _dataset: + +DataSet +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DataSet + :members: diff --git a/docs/asset/datastudio.rst b/docs/asset/datastudio.rst new file mode 100644 index 000000000..3dd83219d --- /dev/null +++ b/docs/asset/datastudio.rst @@ -0,0 +1,10 @@ +.. _datastudio: + +DataStudio +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DataStudio + :members: diff --git a/docs/asset/datastudioasset.rst b/docs/asset/datastudioasset.rst new file mode 100644 index 000000000..c06e00ac2 --- /dev/null +++ b/docs/asset/datastudioasset.rst @@ -0,0 +1,10 @@ +.. _datastudioasset: + +DataStudioAsset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DataStudioAsset + :members: diff --git a/docs/asset/dbt.rst b/docs/asset/dbt.rst new file mode 100644 index 000000000..14b400121 --- /dev/null +++ b/docs/asset/dbt.rst @@ -0,0 +1,10 @@ +.. _dbt: + +Dbt +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Dbt + :members: diff --git a/docs/asset/dbtcolumnprocess.rst b/docs/asset/dbtcolumnprocess.rst new file mode 100644 index 000000000..eecf238d9 --- /dev/null +++ b/docs/asset/dbtcolumnprocess.rst @@ -0,0 +1,10 @@ +.. _dbtcolumnprocess: + +DbtColumnProcess +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtColumnProcess + :members: diff --git a/docs/asset/dbtmetric.rst b/docs/asset/dbtmetric.rst new file mode 100644 index 000000000..faf5d028a --- /dev/null +++ b/docs/asset/dbtmetric.rst @@ -0,0 +1,10 @@ +.. _dbtmetric: + +DbtMetric +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtMetric + :members: diff --git a/docs/asset/dbtmodel.rst b/docs/asset/dbtmodel.rst new file mode 100644 index 000000000..e930c2d5a --- /dev/null +++ b/docs/asset/dbtmodel.rst @@ -0,0 +1,10 @@ +.. _dbtmodel: + +DbtModel +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtModel + :members: diff --git a/docs/asset/dbtmodelcolumn.rst b/docs/asset/dbtmodelcolumn.rst new file mode 100644 index 000000000..4ce5314e3 --- /dev/null +++ b/docs/asset/dbtmodelcolumn.rst @@ -0,0 +1,10 @@ +.. _dbtmodelcolumn: + +DbtModelColumn +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtModelColumn + :members: diff --git a/docs/asset/dbtprocess.rst b/docs/asset/dbtprocess.rst new file mode 100644 index 000000000..6cb3eb725 --- /dev/null +++ b/docs/asset/dbtprocess.rst @@ -0,0 +1,10 @@ +.. _dbtprocess: + +DbtProcess +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtProcess + :members: diff --git a/docs/asset/dbtsource.rst b/docs/asset/dbtsource.rst new file mode 100644 index 000000000..b422b203f --- /dev/null +++ b/docs/asset/dbtsource.rst @@ -0,0 +1,10 @@ +.. _dbtsource: + +DbtSource +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtSource + :members: diff --git a/docs/asset/dbttag.rst b/docs/asset/dbttag.rst new file mode 100644 index 000000000..0a0cc5612 --- /dev/null +++ b/docs/asset/dbttag.rst @@ -0,0 +1,10 @@ +.. _dbttag: + +DbtTag +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtTag + :members: diff --git a/docs/asset/dbttest.rst b/docs/asset/dbttest.rst new file mode 100644 index 000000000..632bcb5f2 --- /dev/null +++ b/docs/asset/dbttest.rst @@ -0,0 +1,10 @@ +.. _dbttest: + +DbtTest +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: DbtTest + :members: diff --git a/docs/asset/eventstore.rst b/docs/asset/eventstore.rst new file mode 100644 index 000000000..204a3e0ed --- /dev/null +++ b/docs/asset/eventstore.rst @@ -0,0 +1,10 @@ +.. _eventstore: + +EventStore +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: EventStore + :members: diff --git a/docs/asset/file.rst b/docs/asset/file.rst new file mode 100644 index 000000000..8b1504000 --- /dev/null +++ b/docs/asset/file.rst @@ -0,0 +1,10 @@ +.. _file: + +File +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: File + :members: diff --git a/docs/asset/folder.rst b/docs/asset/folder.rst new file mode 100644 index 000000000..f745cc601 --- /dev/null +++ b/docs/asset/folder.rst @@ -0,0 +1,10 @@ +.. _folder: + +Folder +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Folder + :members: diff --git a/docs/asset/function.rst b/docs/asset/function.rst new file mode 100644 index 000000000..5abb88d10 --- /dev/null +++ b/docs/asset/function.rst @@ -0,0 +1,10 @@ +.. _function: + +Function +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Function + :members: diff --git a/docs/asset/gcs.rst b/docs/asset/gcs.rst new file mode 100644 index 000000000..cb87dbb0d --- /dev/null +++ b/docs/asset/gcs.rst @@ -0,0 +1,10 @@ +.. _gcs: + +GCS +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: GCS + :members: diff --git a/docs/asset/gcsbucket.rst b/docs/asset/gcsbucket.rst new file mode 100644 index 000000000..2ac961e7c --- /dev/null +++ b/docs/asset/gcsbucket.rst @@ -0,0 +1,10 @@ +.. _gcsbucket: + +GCSBucket +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: GCSBucket + :members: diff --git a/docs/asset/gcsobject.rst b/docs/asset/gcsobject.rst new file mode 100644 index 000000000..577b50207 --- /dev/null +++ b/docs/asset/gcsobject.rst @@ -0,0 +1,10 @@ +.. _gcsobject: + +GCSObject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: GCSObject + :members: diff --git a/docs/asset/google.rst b/docs/asset/google.rst new file mode 100644 index 000000000..a8204b946 --- /dev/null +++ b/docs/asset/google.rst @@ -0,0 +1,10 @@ +.. _google: + +Google +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Google + :members: diff --git a/docs/asset/infrastructure.rst b/docs/asset/infrastructure.rst new file mode 100644 index 000000000..26429ae96 --- /dev/null +++ b/docs/asset/infrastructure.rst @@ -0,0 +1,10 @@ +.. _infrastructure: + +Infrastructure +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Infrastructure + :members: diff --git a/docs/asset/insight.rst b/docs/asset/insight.rst new file mode 100644 index 000000000..fa6f03e05 --- /dev/null +++ b/docs/asset/insight.rst @@ -0,0 +1,10 @@ +.. _insight: + +Insight +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Insight + :members: diff --git a/docs/asset/kafka.rst b/docs/asset/kafka.rst new file mode 100644 index 000000000..3bf420f3b --- /dev/null +++ b/docs/asset/kafka.rst @@ -0,0 +1,10 @@ +.. _kafka: + +Kafka +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Kafka + :members: diff --git a/docs/asset/kafkaconsumergroup.rst b/docs/asset/kafkaconsumergroup.rst new file mode 100644 index 000000000..1ec24ca91 --- /dev/null +++ b/docs/asset/kafkaconsumergroup.rst @@ -0,0 +1,10 @@ +.. _kafkaconsumergroup: + +KafkaConsumerGroup +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: KafkaConsumerGroup + :members: diff --git a/docs/asset/kafkatopic.rst b/docs/asset/kafkatopic.rst new file mode 100644 index 000000000..ffd9b92d3 --- /dev/null +++ b/docs/asset/kafkatopic.rst @@ -0,0 +1,10 @@ +.. _kafkatopic: + +KafkaTopic +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: KafkaTopic + :members: diff --git a/docs/asset/link.rst b/docs/asset/link.rst new file mode 100644 index 000000000..fa26bb73c --- /dev/null +++ b/docs/asset/link.rst @@ -0,0 +1,10 @@ +.. _link: + +Link +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Link + :members: diff --git a/docs/asset/looker.rst b/docs/asset/looker.rst new file mode 100644 index 000000000..a3d440ce7 --- /dev/null +++ b/docs/asset/looker.rst @@ -0,0 +1,10 @@ +.. _looker: + +Looker +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Looker + :members: diff --git a/docs/asset/lookerdashboard.rst b/docs/asset/lookerdashboard.rst new file mode 100644 index 000000000..9ae39b4bb --- /dev/null +++ b/docs/asset/lookerdashboard.rst @@ -0,0 +1,10 @@ +.. _lookerdashboard: + +LookerDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerDashboard + :members: diff --git a/docs/asset/lookerexplore.rst b/docs/asset/lookerexplore.rst new file mode 100644 index 000000000..6a060156e --- /dev/null +++ b/docs/asset/lookerexplore.rst @@ -0,0 +1,10 @@ +.. _lookerexplore: + +LookerExplore +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerExplore + :members: diff --git a/docs/asset/lookerfield.rst b/docs/asset/lookerfield.rst new file mode 100644 index 000000000..c219ef16b --- /dev/null +++ b/docs/asset/lookerfield.rst @@ -0,0 +1,10 @@ +.. _lookerfield: + +LookerField +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerField + :members: diff --git a/docs/asset/lookerfolder.rst b/docs/asset/lookerfolder.rst new file mode 100644 index 000000000..5d1968f3b --- /dev/null +++ b/docs/asset/lookerfolder.rst @@ -0,0 +1,10 @@ +.. _lookerfolder: + +LookerFolder +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerFolder + :members: diff --git a/docs/asset/lookerlook.rst b/docs/asset/lookerlook.rst new file mode 100644 index 000000000..846d8cb1a --- /dev/null +++ b/docs/asset/lookerlook.rst @@ -0,0 +1,10 @@ +.. _lookerlook: + +LookerLook +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerLook + :members: diff --git a/docs/asset/lookermodel.rst b/docs/asset/lookermodel.rst new file mode 100644 index 000000000..203282875 --- /dev/null +++ b/docs/asset/lookermodel.rst @@ -0,0 +1,10 @@ +.. _lookermodel: + +LookerModel +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerModel + :members: diff --git a/docs/asset/lookerproject.rst b/docs/asset/lookerproject.rst new file mode 100644 index 000000000..23fe121f6 --- /dev/null +++ b/docs/asset/lookerproject.rst @@ -0,0 +1,10 @@ +.. _lookerproject: + +LookerProject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerProject + :members: diff --git a/docs/asset/lookerquery.rst b/docs/asset/lookerquery.rst new file mode 100644 index 000000000..546378827 --- /dev/null +++ b/docs/asset/lookerquery.rst @@ -0,0 +1,10 @@ +.. _lookerquery: + +LookerQuery +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerQuery + :members: diff --git a/docs/asset/lookertile.rst b/docs/asset/lookertile.rst new file mode 100644 index 000000000..6cfa8c118 --- /dev/null +++ b/docs/asset/lookertile.rst @@ -0,0 +1,10 @@ +.. _lookertile: + +LookerTile +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerTile + :members: diff --git a/docs/asset/lookerview.rst b/docs/asset/lookerview.rst new file mode 100644 index 000000000..2e92601cc --- /dev/null +++ b/docs/asset/lookerview.rst @@ -0,0 +1,10 @@ +.. _lookerview: + +LookerView +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: LookerView + :members: diff --git a/docs/asset/materialisedview.rst b/docs/asset/materialisedview.rst new file mode 100644 index 000000000..a8945b5e0 --- /dev/null +++ b/docs/asset/materialisedview.rst @@ -0,0 +1,10 @@ +.. _materialisedview: + +MaterialisedView +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MaterialisedView + :members: diff --git a/docs/asset/matillion.rst b/docs/asset/matillion.rst new file mode 100644 index 000000000..04a6d5f06 --- /dev/null +++ b/docs/asset/matillion.rst @@ -0,0 +1,10 @@ +.. _matillion: + +Matillion +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Matillion + :members: diff --git a/docs/asset/matillioncomponent.rst b/docs/asset/matillioncomponent.rst new file mode 100644 index 000000000..f4f2a4472 --- /dev/null +++ b/docs/asset/matillioncomponent.rst @@ -0,0 +1,10 @@ +.. _matillioncomponent: + +MatillionComponent +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MatillionComponent + :members: diff --git a/docs/asset/matilliongroup.rst b/docs/asset/matilliongroup.rst new file mode 100644 index 000000000..c27d41050 --- /dev/null +++ b/docs/asset/matilliongroup.rst @@ -0,0 +1,10 @@ +.. _matilliongroup: + +MatillionGroup +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MatillionGroup + :members: diff --git a/docs/asset/matillionjob.rst b/docs/asset/matillionjob.rst new file mode 100644 index 000000000..3200b695f --- /dev/null +++ b/docs/asset/matillionjob.rst @@ -0,0 +1,10 @@ +.. _matillionjob: + +MatillionJob +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MatillionJob + :members: diff --git a/docs/asset/matillionproject.rst b/docs/asset/matillionproject.rst new file mode 100644 index 000000000..7848b732c --- /dev/null +++ b/docs/asset/matillionproject.rst @@ -0,0 +1,10 @@ +.. _matillionproject: + +MatillionProject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MatillionProject + :members: diff --git a/docs/asset/mcincident.rst b/docs/asset/mcincident.rst new file mode 100644 index 000000000..e08917a68 --- /dev/null +++ b/docs/asset/mcincident.rst @@ -0,0 +1,10 @@ +.. _mcincident: + +MCIncident +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MCIncident + :members: diff --git a/docs/asset/mcmonitor.rst b/docs/asset/mcmonitor.rst new file mode 100644 index 000000000..5cb0661ae --- /dev/null +++ b/docs/asset/mcmonitor.rst @@ -0,0 +1,10 @@ +.. _mcmonitor: + +MCMonitor +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MCMonitor + :members: diff --git a/docs/asset/metabase.rst b/docs/asset/metabase.rst new file mode 100644 index 000000000..74135ceec --- /dev/null +++ b/docs/asset/metabase.rst @@ -0,0 +1,10 @@ +.. _metabase: + +Metabase +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Metabase + :members: diff --git a/docs/asset/metabasecollection.rst b/docs/asset/metabasecollection.rst new file mode 100644 index 000000000..d4a8da9b9 --- /dev/null +++ b/docs/asset/metabasecollection.rst @@ -0,0 +1,10 @@ +.. _metabasecollection: + +MetabaseCollection +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MetabaseCollection + :members: diff --git a/docs/asset/metabasedashboard.rst b/docs/asset/metabasedashboard.rst new file mode 100644 index 000000000..10d395f9c --- /dev/null +++ b/docs/asset/metabasedashboard.rst @@ -0,0 +1,10 @@ +.. _metabasedashboard: + +MetabaseDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MetabaseDashboard + :members: diff --git a/docs/asset/metabasequestion.rst b/docs/asset/metabasequestion.rst new file mode 100644 index 000000000..5ec4a1aba --- /dev/null +++ b/docs/asset/metabasequestion.rst @@ -0,0 +1,10 @@ +.. _metabasequestion: + +MetabaseQuestion +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MetabaseQuestion + :members: diff --git a/docs/asset/metric.rst b/docs/asset/metric.rst new file mode 100644 index 000000000..09c551e7f --- /dev/null +++ b/docs/asset/metric.rst @@ -0,0 +1,10 @@ +.. _metric: + +Metric +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Metric + :members: diff --git a/docs/asset/microstrategy.rst b/docs/asset/microstrategy.rst new file mode 100644 index 000000000..53fe7d455 --- /dev/null +++ b/docs/asset/microstrategy.rst @@ -0,0 +1,10 @@ +.. _microstrategy: + +MicroStrategy +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategy + :members: diff --git a/docs/asset/microstrategyattribute.rst b/docs/asset/microstrategyattribute.rst new file mode 100644 index 000000000..b514ad140 --- /dev/null +++ b/docs/asset/microstrategyattribute.rst @@ -0,0 +1,10 @@ +.. _microstrategyattribute: + +MicroStrategyAttribute +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyAttribute + :members: diff --git a/docs/asset/microstrategycube.rst b/docs/asset/microstrategycube.rst new file mode 100644 index 000000000..38ee98e4a --- /dev/null +++ b/docs/asset/microstrategycube.rst @@ -0,0 +1,10 @@ +.. _microstrategycube: + +MicroStrategyCube +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyCube + :members: diff --git a/docs/asset/microstrategydocument.rst b/docs/asset/microstrategydocument.rst new file mode 100644 index 000000000..13fb94e2a --- /dev/null +++ b/docs/asset/microstrategydocument.rst @@ -0,0 +1,10 @@ +.. _microstrategydocument: + +MicroStrategyDocument +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyDocument + :members: diff --git a/docs/asset/microstrategydossier.rst b/docs/asset/microstrategydossier.rst new file mode 100644 index 000000000..c0e8bad61 --- /dev/null +++ b/docs/asset/microstrategydossier.rst @@ -0,0 +1,10 @@ +.. _microstrategydossier: + +MicroStrategyDossier +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyDossier + :members: diff --git a/docs/asset/microstrategyfact.rst b/docs/asset/microstrategyfact.rst new file mode 100644 index 000000000..57aba7844 --- /dev/null +++ b/docs/asset/microstrategyfact.rst @@ -0,0 +1,10 @@ +.. _microstrategyfact: + +MicroStrategyFact +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyFact + :members: diff --git a/docs/asset/microstrategymetric.rst b/docs/asset/microstrategymetric.rst new file mode 100644 index 000000000..a6c3be718 --- /dev/null +++ b/docs/asset/microstrategymetric.rst @@ -0,0 +1,10 @@ +.. _microstrategymetric: + +MicroStrategyMetric +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyMetric + :members: diff --git a/docs/asset/microstrategyproject.rst b/docs/asset/microstrategyproject.rst new file mode 100644 index 000000000..5eda93ac4 --- /dev/null +++ b/docs/asset/microstrategyproject.rst @@ -0,0 +1,10 @@ +.. _microstrategyproject: + +MicroStrategyProject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyProject + :members: diff --git a/docs/asset/microstrategyreport.rst b/docs/asset/microstrategyreport.rst new file mode 100644 index 000000000..98fedce27 --- /dev/null +++ b/docs/asset/microstrategyreport.rst @@ -0,0 +1,10 @@ +.. _microstrategyreport: + +MicroStrategyReport +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyReport + :members: diff --git a/docs/asset/microstrategyvisualization.rst b/docs/asset/microstrategyvisualization.rst new file mode 100644 index 000000000..b6ab31ca3 --- /dev/null +++ b/docs/asset/microstrategyvisualization.rst @@ -0,0 +1,10 @@ +.. _microstrategyvisualization: + +MicroStrategyVisualization +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MicroStrategyVisualization + :members: diff --git a/docs/asset/mode.rst b/docs/asset/mode.rst new file mode 100644 index 000000000..9339aea3a --- /dev/null +++ b/docs/asset/mode.rst @@ -0,0 +1,10 @@ +.. _mode: + +Mode +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Mode + :members: diff --git a/docs/asset/modechart.rst b/docs/asset/modechart.rst new file mode 100644 index 000000000..0bcbb904d --- /dev/null +++ b/docs/asset/modechart.rst @@ -0,0 +1,10 @@ +.. _modechart: + +ModeChart +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ModeChart + :members: diff --git a/docs/asset/modecollection.rst b/docs/asset/modecollection.rst new file mode 100644 index 000000000..83649cfb5 --- /dev/null +++ b/docs/asset/modecollection.rst @@ -0,0 +1,10 @@ +.. _modecollection: + +ModeCollection +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ModeCollection + :members: diff --git a/docs/asset/modequery.rst b/docs/asset/modequery.rst new file mode 100644 index 000000000..7ca5bcd69 --- /dev/null +++ b/docs/asset/modequery.rst @@ -0,0 +1,10 @@ +.. _modequery: + +ModeQuery +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ModeQuery + :members: diff --git a/docs/asset/modereport.rst b/docs/asset/modereport.rst new file mode 100644 index 000000000..ad08215f9 --- /dev/null +++ b/docs/asset/modereport.rst @@ -0,0 +1,10 @@ +.. _modereport: + +ModeReport +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ModeReport + :members: diff --git a/docs/asset/modeworkspace.rst b/docs/asset/modeworkspace.rst new file mode 100644 index 000000000..f6fc28c7a --- /dev/null +++ b/docs/asset/modeworkspace.rst @@ -0,0 +1,10 @@ +.. _modeworkspace: + +ModeWorkspace +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ModeWorkspace + :members: diff --git a/docs/asset/mongodb.rst b/docs/asset/mongodb.rst new file mode 100644 index 000000000..67ed9e7b8 --- /dev/null +++ b/docs/asset/mongodb.rst @@ -0,0 +1,10 @@ +.. _mongodb: + +MongoDB +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MongoDB + :members: diff --git a/docs/asset/mongodbcollection.rst b/docs/asset/mongodbcollection.rst new file mode 100644 index 000000000..9a9851179 --- /dev/null +++ b/docs/asset/mongodbcollection.rst @@ -0,0 +1,10 @@ +.. _mongodbcollection: + +MongoDBCollection +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MongoDBCollection + :members: diff --git a/docs/asset/mongodbdatabase.rst b/docs/asset/mongodbdatabase.rst new file mode 100644 index 000000000..2a35a10b3 --- /dev/null +++ b/docs/asset/mongodbdatabase.rst @@ -0,0 +1,10 @@ +.. _mongodbdatabase: + +MongoDBDatabase +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MongoDBDatabase + :members: diff --git a/docs/asset/montecarlo.rst b/docs/asset/montecarlo.rst new file mode 100644 index 000000000..c0fe5ff7c --- /dev/null +++ b/docs/asset/montecarlo.rst @@ -0,0 +1,10 @@ +.. _montecarlo: + +MonteCarlo +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: MonteCarlo + :members: diff --git a/docs/asset/namespace.rst b/docs/asset/namespace.rst new file mode 100644 index 000000000..07f6ef0c6 --- /dev/null +++ b/docs/asset/namespace.rst @@ -0,0 +1,10 @@ +.. _namespace: + +Namespace +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Namespace + :members: diff --git a/docs/asset/nosql.rst b/docs/asset/nosql.rst new file mode 100644 index 000000000..3bdbae22d --- /dev/null +++ b/docs/asset/nosql.rst @@ -0,0 +1,10 @@ +.. _nosql: + +NoSQL +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: NoSQL + :members: diff --git a/docs/asset/objectstore.rst b/docs/asset/objectstore.rst new file mode 100644 index 000000000..a634e4e73 --- /dev/null +++ b/docs/asset/objectstore.rst @@ -0,0 +1,10 @@ +.. _objectstore: + +ObjectStore +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ObjectStore + :members: diff --git a/docs/asset/persona.rst b/docs/asset/persona.rst new file mode 100644 index 000000000..b9101e38d --- /dev/null +++ b/docs/asset/persona.rst @@ -0,0 +1,10 @@ +.. _persona: + +Persona +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Persona + :members: diff --git a/docs/asset/powerbi.rst b/docs/asset/powerbi.rst new file mode 100644 index 000000000..170490db3 --- /dev/null +++ b/docs/asset/powerbi.rst @@ -0,0 +1,10 @@ +.. _powerbi: + +PowerBI +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBI + :members: diff --git a/docs/asset/powerbicolumn.rst b/docs/asset/powerbicolumn.rst new file mode 100644 index 000000000..1a58b688c --- /dev/null +++ b/docs/asset/powerbicolumn.rst @@ -0,0 +1,10 @@ +.. _powerbicolumn: + +PowerBIColumn +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIColumn + :members: diff --git a/docs/asset/powerbidashboard.rst b/docs/asset/powerbidashboard.rst new file mode 100644 index 000000000..d41c6816a --- /dev/null +++ b/docs/asset/powerbidashboard.rst @@ -0,0 +1,10 @@ +.. _powerbidashboard: + +PowerBIDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIDashboard + :members: diff --git a/docs/asset/powerbidataflow.rst b/docs/asset/powerbidataflow.rst new file mode 100644 index 000000000..d5b860805 --- /dev/null +++ b/docs/asset/powerbidataflow.rst @@ -0,0 +1,10 @@ +.. _powerbidataflow: + +PowerBIDataflow +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIDataflow + :members: diff --git a/docs/asset/powerbidataset.rst b/docs/asset/powerbidataset.rst new file mode 100644 index 000000000..7cffde797 --- /dev/null +++ b/docs/asset/powerbidataset.rst @@ -0,0 +1,10 @@ +.. _powerbidataset: + +PowerBIDataset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIDataset + :members: diff --git a/docs/asset/powerbidatasource.rst b/docs/asset/powerbidatasource.rst new file mode 100644 index 000000000..d63873520 --- /dev/null +++ b/docs/asset/powerbidatasource.rst @@ -0,0 +1,10 @@ +.. _powerbidatasource: + +PowerBIDatasource +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIDatasource + :members: diff --git a/docs/asset/powerbimeasure.rst b/docs/asset/powerbimeasure.rst new file mode 100644 index 000000000..13ff497c4 --- /dev/null +++ b/docs/asset/powerbimeasure.rst @@ -0,0 +1,10 @@ +.. _powerbimeasure: + +PowerBIMeasure +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIMeasure + :members: diff --git a/docs/asset/powerbipage.rst b/docs/asset/powerbipage.rst new file mode 100644 index 000000000..860f00d61 --- /dev/null +++ b/docs/asset/powerbipage.rst @@ -0,0 +1,10 @@ +.. _powerbipage: + +PowerBIPage +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIPage + :members: diff --git a/docs/asset/powerbireport.rst b/docs/asset/powerbireport.rst new file mode 100644 index 000000000..53e0f3744 --- /dev/null +++ b/docs/asset/powerbireport.rst @@ -0,0 +1,10 @@ +.. _powerbireport: + +PowerBIReport +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIReport + :members: diff --git a/docs/asset/powerbitable.rst b/docs/asset/powerbitable.rst new file mode 100644 index 000000000..fba6b8d8c --- /dev/null +++ b/docs/asset/powerbitable.rst @@ -0,0 +1,10 @@ +.. _powerbitable: + +PowerBITable +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBITable + :members: diff --git a/docs/asset/powerbitile.rst b/docs/asset/powerbitile.rst new file mode 100644 index 000000000..60852db19 --- /dev/null +++ b/docs/asset/powerbitile.rst @@ -0,0 +1,10 @@ +.. _powerbitile: + +PowerBITile +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBITile + :members: diff --git a/docs/asset/powerbiworkspace.rst b/docs/asset/powerbiworkspace.rst new file mode 100644 index 000000000..6adb047a7 --- /dev/null +++ b/docs/asset/powerbiworkspace.rst @@ -0,0 +1,10 @@ +.. _powerbiworkspace: + +PowerBIWorkspace +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PowerBIWorkspace + :members: diff --git a/docs/asset/preset.rst b/docs/asset/preset.rst new file mode 100644 index 000000000..dbbda5d9b --- /dev/null +++ b/docs/asset/preset.rst @@ -0,0 +1,10 @@ +.. _preset: + +Preset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Preset + :members: diff --git a/docs/asset/presetchart.rst b/docs/asset/presetchart.rst new file mode 100644 index 000000000..ae6a1e48e --- /dev/null +++ b/docs/asset/presetchart.rst @@ -0,0 +1,10 @@ +.. _presetchart: + +PresetChart +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PresetChart + :members: diff --git a/docs/asset/presetdashboard.rst b/docs/asset/presetdashboard.rst new file mode 100644 index 000000000..29f327f25 --- /dev/null +++ b/docs/asset/presetdashboard.rst @@ -0,0 +1,10 @@ +.. _presetdashboard: + +PresetDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PresetDashboard + :members: diff --git a/docs/asset/presetdataset.rst b/docs/asset/presetdataset.rst new file mode 100644 index 000000000..ad9d9885c --- /dev/null +++ b/docs/asset/presetdataset.rst @@ -0,0 +1,10 @@ +.. _presetdataset: + +PresetDataset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PresetDataset + :members: diff --git a/docs/asset/presetworkspace.rst b/docs/asset/presetworkspace.rst new file mode 100644 index 000000000..04216a38f --- /dev/null +++ b/docs/asset/presetworkspace.rst @@ -0,0 +1,10 @@ +.. _presetworkspace: + +PresetWorkspace +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: PresetWorkspace + :members: diff --git a/docs/asset/procedure.rst b/docs/asset/procedure.rst new file mode 100644 index 000000000..e9a6ec0fb --- /dev/null +++ b/docs/asset/procedure.rst @@ -0,0 +1,10 @@ +.. _procedure: + +Procedure +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Procedure + :members: diff --git a/docs/asset/process.rst b/docs/asset/process.rst new file mode 100644 index 000000000..9aa8022b0 --- /dev/null +++ b/docs/asset/process.rst @@ -0,0 +1,10 @@ +.. _process: + +Process +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Process + :members: diff --git a/docs/asset/processexecution.rst b/docs/asset/processexecution.rst new file mode 100644 index 000000000..6c994a8ce --- /dev/null +++ b/docs/asset/processexecution.rst @@ -0,0 +1,10 @@ +.. _processexecution: + +ProcessExecution +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ProcessExecution + :members: diff --git a/docs/asset/purpose.rst b/docs/asset/purpose.rst new file mode 100644 index 000000000..a7bd4354c --- /dev/null +++ b/docs/asset/purpose.rst @@ -0,0 +1,10 @@ +.. _purpose: + +Purpose +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Purpose + :members: diff --git a/docs/asset/qlik.rst b/docs/asset/qlik.rst new file mode 100644 index 000000000..b56d61c6e --- /dev/null +++ b/docs/asset/qlik.rst @@ -0,0 +1,10 @@ +.. _qlik: + +Qlik +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Qlik + :members: diff --git a/docs/asset/qlikapp.rst b/docs/asset/qlikapp.rst new file mode 100644 index 000000000..2c74d5524 --- /dev/null +++ b/docs/asset/qlikapp.rst @@ -0,0 +1,10 @@ +.. _qlikapp: + +QlikApp +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QlikApp + :members: diff --git a/docs/asset/qlikchart.rst b/docs/asset/qlikchart.rst new file mode 100644 index 000000000..8bba9d23d --- /dev/null +++ b/docs/asset/qlikchart.rst @@ -0,0 +1,10 @@ +.. _qlikchart: + +QlikChart +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QlikChart + :members: diff --git a/docs/asset/qlikdataset.rst b/docs/asset/qlikdataset.rst new file mode 100644 index 000000000..1c98cd81a --- /dev/null +++ b/docs/asset/qlikdataset.rst @@ -0,0 +1,10 @@ +.. _qlikdataset: + +QlikDataset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QlikDataset + :members: diff --git a/docs/asset/qliksheet.rst b/docs/asset/qliksheet.rst new file mode 100644 index 000000000..a9a7758d6 --- /dev/null +++ b/docs/asset/qliksheet.rst @@ -0,0 +1,10 @@ +.. _qliksheet: + +QlikSheet +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QlikSheet + :members: diff --git a/docs/asset/qlikspace.rst b/docs/asset/qlikspace.rst new file mode 100644 index 000000000..bbdbde90a --- /dev/null +++ b/docs/asset/qlikspace.rst @@ -0,0 +1,10 @@ +.. _qlikspace: + +QlikSpace +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QlikSpace + :members: diff --git a/docs/asset/qlikstream.rst b/docs/asset/qlikstream.rst new file mode 100644 index 000000000..b2f8d26d9 --- /dev/null +++ b/docs/asset/qlikstream.rst @@ -0,0 +1,10 @@ +.. _qlikstream: + +QlikStream +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QlikStream + :members: diff --git a/docs/asset/query.rst b/docs/asset/query.rst new file mode 100644 index 000000000..cb9ada8fe --- /dev/null +++ b/docs/asset/query.rst @@ -0,0 +1,10 @@ +.. _query: + +Query +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Query + :members: diff --git a/docs/asset/quicksight.rst b/docs/asset/quicksight.rst new file mode 100644 index 000000000..67caf7a7d --- /dev/null +++ b/docs/asset/quicksight.rst @@ -0,0 +1,10 @@ +.. _quicksight: + +QuickSight +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSight + :members: diff --git a/docs/asset/quicksightanalysis.rst b/docs/asset/quicksightanalysis.rst new file mode 100644 index 000000000..9214d27b1 --- /dev/null +++ b/docs/asset/quicksightanalysis.rst @@ -0,0 +1,10 @@ +.. _quicksightanalysis: + +QuickSightAnalysis +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightAnalysis + :members: diff --git a/docs/asset/quicksightanalysisvisual.rst b/docs/asset/quicksightanalysisvisual.rst new file mode 100644 index 000000000..eb4085ce8 --- /dev/null +++ b/docs/asset/quicksightanalysisvisual.rst @@ -0,0 +1,10 @@ +.. _quicksightanalysisvisual: + +QuickSightAnalysisVisual +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightAnalysisVisual + :members: diff --git a/docs/asset/quicksightdashboard.rst b/docs/asset/quicksightdashboard.rst new file mode 100644 index 000000000..487788422 --- /dev/null +++ b/docs/asset/quicksightdashboard.rst @@ -0,0 +1,10 @@ +.. _quicksightdashboard: + +QuickSightDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightDashboard + :members: diff --git a/docs/asset/quicksightdashboardvisual.rst b/docs/asset/quicksightdashboardvisual.rst new file mode 100644 index 000000000..fddc0f1df --- /dev/null +++ b/docs/asset/quicksightdashboardvisual.rst @@ -0,0 +1,10 @@ +.. _quicksightdashboardvisual: + +QuickSightDashboardVisual +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightDashboardVisual + :members: diff --git a/docs/asset/quicksightdataset.rst b/docs/asset/quicksightdataset.rst new file mode 100644 index 000000000..724f17687 --- /dev/null +++ b/docs/asset/quicksightdataset.rst @@ -0,0 +1,10 @@ +.. _quicksightdataset: + +QuickSightDataset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightDataset + :members: diff --git a/docs/asset/quicksightdatasetfield.rst b/docs/asset/quicksightdatasetfield.rst new file mode 100644 index 000000000..61ed324e2 --- /dev/null +++ b/docs/asset/quicksightdatasetfield.rst @@ -0,0 +1,10 @@ +.. _quicksightdatasetfield: + +QuickSightDatasetField +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightDatasetField + :members: diff --git a/docs/asset/quicksightfolder.rst b/docs/asset/quicksightfolder.rst new file mode 100644 index 000000000..c153f9123 --- /dev/null +++ b/docs/asset/quicksightfolder.rst @@ -0,0 +1,10 @@ +.. _quicksightfolder: + +QuickSightFolder +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: QuickSightFolder + :members: diff --git a/docs/asset/readme.rst b/docs/asset/readme.rst new file mode 100644 index 000000000..5119b6b0e --- /dev/null +++ b/docs/asset/readme.rst @@ -0,0 +1,10 @@ +.. _readme: + +Readme +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Readme + :members: diff --git a/docs/asset/readmetemplate.rst b/docs/asset/readmetemplate.rst new file mode 100644 index 000000000..63781ccf9 --- /dev/null +++ b/docs/asset/readmetemplate.rst @@ -0,0 +1,10 @@ +.. _readmetemplate: + +ReadmeTemplate +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ReadmeTemplate + :members: diff --git a/docs/asset/redash.rst b/docs/asset/redash.rst new file mode 100644 index 000000000..ce6694c80 --- /dev/null +++ b/docs/asset/redash.rst @@ -0,0 +1,10 @@ +.. _redash: + +Redash +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Redash + :members: diff --git a/docs/asset/redashdashboard.rst b/docs/asset/redashdashboard.rst new file mode 100644 index 000000000..2dcacea25 --- /dev/null +++ b/docs/asset/redashdashboard.rst @@ -0,0 +1,10 @@ +.. _redashdashboard: + +RedashDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: RedashDashboard + :members: diff --git a/docs/asset/redashquery.rst b/docs/asset/redashquery.rst new file mode 100644 index 000000000..12eb176ca --- /dev/null +++ b/docs/asset/redashquery.rst @@ -0,0 +1,10 @@ +.. _redashquery: + +RedashQuery +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: RedashQuery + :members: diff --git a/docs/asset/redashvisualization.rst b/docs/asset/redashvisualization.rst new file mode 100644 index 000000000..c3ce5f2a5 --- /dev/null +++ b/docs/asset/redashvisualization.rst @@ -0,0 +1,10 @@ +.. _redashvisualization: + +RedashVisualization +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: RedashVisualization + :members: diff --git a/docs/asset/referenceable.rst b/docs/asset/referenceable.rst new file mode 100644 index 000000000..3fac63cf8 --- /dev/null +++ b/docs/asset/referenceable.rst @@ -0,0 +1,10 @@ +.. _referenceable: + +Referenceable +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Referenceable + :members: diff --git a/docs/asset/resource.rst b/docs/asset/resource.rst new file mode 100644 index 000000000..eb6ba051d --- /dev/null +++ b/docs/asset/resource.rst @@ -0,0 +1,10 @@ +.. _resource: + +Resource +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Resource + :members: diff --git a/docs/asset/s3.rst b/docs/asset/s3.rst new file mode 100644 index 000000000..a54634a2a --- /dev/null +++ b/docs/asset/s3.rst @@ -0,0 +1,10 @@ +.. _s3: + +S3 +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: S3 + :members: diff --git a/docs/asset/s3bucket.rst b/docs/asset/s3bucket.rst new file mode 100644 index 000000000..cbb6af563 --- /dev/null +++ b/docs/asset/s3bucket.rst @@ -0,0 +1,10 @@ +.. _s3bucket: + +S3Bucket +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: S3Bucket + :members: diff --git a/docs/asset/s3object.rst b/docs/asset/s3object.rst new file mode 100644 index 000000000..5bce067a4 --- /dev/null +++ b/docs/asset/s3object.rst @@ -0,0 +1,10 @@ +.. _s3object: + +S3Object +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: S3Object + :members: diff --git a/docs/asset/saas.rst b/docs/asset/saas.rst new file mode 100644 index 000000000..2d759dfcd --- /dev/null +++ b/docs/asset/saas.rst @@ -0,0 +1,10 @@ +.. _saas: + +SaaS +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SaaS + :members: diff --git a/docs/asset/salesforce.rst b/docs/asset/salesforce.rst new file mode 100644 index 000000000..c4fe51792 --- /dev/null +++ b/docs/asset/salesforce.rst @@ -0,0 +1,10 @@ +.. _salesforce: + +Salesforce +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Salesforce + :members: diff --git a/docs/asset/salesforcedashboard.rst b/docs/asset/salesforcedashboard.rst new file mode 100644 index 000000000..00298d73a --- /dev/null +++ b/docs/asset/salesforcedashboard.rst @@ -0,0 +1,10 @@ +.. _salesforcedashboard: + +SalesforceDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SalesforceDashboard + :members: diff --git a/docs/asset/salesforcefield.rst b/docs/asset/salesforcefield.rst new file mode 100644 index 000000000..838938b5a --- /dev/null +++ b/docs/asset/salesforcefield.rst @@ -0,0 +1,10 @@ +.. _salesforcefield: + +SalesforceField +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SalesforceField + :members: diff --git a/docs/asset/salesforceobject.rst b/docs/asset/salesforceobject.rst new file mode 100644 index 000000000..1b43a1cbc --- /dev/null +++ b/docs/asset/salesforceobject.rst @@ -0,0 +1,10 @@ +.. _salesforceobject: + +SalesforceObject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SalesforceObject + :members: diff --git a/docs/asset/salesforceorganization.rst b/docs/asset/salesforceorganization.rst new file mode 100644 index 000000000..2b5bc613b --- /dev/null +++ b/docs/asset/salesforceorganization.rst @@ -0,0 +1,10 @@ +.. _salesforceorganization: + +SalesforceOrganization +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SalesforceOrganization + :members: diff --git a/docs/asset/salesforcereport.rst b/docs/asset/salesforcereport.rst new file mode 100644 index 000000000..8bb6bd433 --- /dev/null +++ b/docs/asset/salesforcereport.rst @@ -0,0 +1,10 @@ +.. _salesforcereport: + +SalesforceReport +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SalesforceReport + :members: diff --git a/docs/asset/schema.rst b/docs/asset/schema.rst new file mode 100644 index 000000000..7fe7c9d36 --- /dev/null +++ b/docs/asset/schema.rst @@ -0,0 +1,10 @@ +.. _schema: + +Schema +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Schema + :members: diff --git a/docs/asset/schemaregistry.rst b/docs/asset/schemaregistry.rst new file mode 100644 index 000000000..7c4d6224f --- /dev/null +++ b/docs/asset/schemaregistry.rst @@ -0,0 +1,10 @@ +.. _schemaregistry: + +SchemaRegistry +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SchemaRegistry + :members: diff --git a/docs/asset/schemaregistrysubject.rst b/docs/asset/schemaregistrysubject.rst new file mode 100644 index 000000000..635ee5bb1 --- /dev/null +++ b/docs/asset/schemaregistrysubject.rst @@ -0,0 +1,10 @@ +.. _schemaregistrysubject: + +SchemaRegistrySubject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SchemaRegistrySubject + :members: diff --git a/docs/asset/sigma.rst b/docs/asset/sigma.rst new file mode 100644 index 000000000..7264e8f17 --- /dev/null +++ b/docs/asset/sigma.rst @@ -0,0 +1,10 @@ +.. _sigma: + +Sigma +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Sigma + :members: diff --git a/docs/asset/sigmadataelement.rst b/docs/asset/sigmadataelement.rst new file mode 100644 index 000000000..cea565e31 --- /dev/null +++ b/docs/asset/sigmadataelement.rst @@ -0,0 +1,10 @@ +.. _sigmadataelement: + +SigmaDataElement +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SigmaDataElement + :members: diff --git a/docs/asset/sigmadataelementfield.rst b/docs/asset/sigmadataelementfield.rst new file mode 100644 index 000000000..c67f033a8 --- /dev/null +++ b/docs/asset/sigmadataelementfield.rst @@ -0,0 +1,10 @@ +.. _sigmadataelementfield: + +SigmaDataElementField +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SigmaDataElementField + :members: diff --git a/docs/asset/sigmadataset.rst b/docs/asset/sigmadataset.rst new file mode 100644 index 000000000..916a0a025 --- /dev/null +++ b/docs/asset/sigmadataset.rst @@ -0,0 +1,10 @@ +.. _sigmadataset: + +SigmaDataset +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SigmaDataset + :members: diff --git a/docs/asset/sigmadatasetcolumn.rst b/docs/asset/sigmadatasetcolumn.rst new file mode 100644 index 000000000..d3cca230c --- /dev/null +++ b/docs/asset/sigmadatasetcolumn.rst @@ -0,0 +1,10 @@ +.. _sigmadatasetcolumn: + +SigmaDatasetColumn +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SigmaDatasetColumn + :members: diff --git a/docs/asset/sigmapage.rst b/docs/asset/sigmapage.rst new file mode 100644 index 000000000..4e6ff2395 --- /dev/null +++ b/docs/asset/sigmapage.rst @@ -0,0 +1,10 @@ +.. _sigmapage: + +SigmaPage +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SigmaPage + :members: diff --git a/docs/asset/sigmaworkbook.rst b/docs/asset/sigmaworkbook.rst new file mode 100644 index 000000000..e6339f023 --- /dev/null +++ b/docs/asset/sigmaworkbook.rst @@ -0,0 +1,10 @@ +.. _sigmaworkbook: + +SigmaWorkbook +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SigmaWorkbook + :members: diff --git a/docs/asset/snowflakedynamictable.rst b/docs/asset/snowflakedynamictable.rst new file mode 100644 index 000000000..18678691a --- /dev/null +++ b/docs/asset/snowflakedynamictable.rst @@ -0,0 +1,10 @@ +.. _snowflakedynamictable: + +SnowflakeDynamicTable +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SnowflakeDynamicTable + :members: diff --git a/docs/asset/snowflakepipe.rst b/docs/asset/snowflakepipe.rst new file mode 100644 index 000000000..0434bb9a1 --- /dev/null +++ b/docs/asset/snowflakepipe.rst @@ -0,0 +1,10 @@ +.. _snowflakepipe: + +SnowflakePipe +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SnowflakePipe + :members: diff --git a/docs/asset/snowflakestream.rst b/docs/asset/snowflakestream.rst new file mode 100644 index 000000000..774d95491 --- /dev/null +++ b/docs/asset/snowflakestream.rst @@ -0,0 +1,10 @@ +.. _snowflakestream: + +SnowflakeStream +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SnowflakeStream + :members: diff --git a/docs/asset/snowflaketag.rst b/docs/asset/snowflaketag.rst new file mode 100644 index 000000000..22404f5d4 --- /dev/null +++ b/docs/asset/snowflaketag.rst @@ -0,0 +1,10 @@ +.. _snowflaketag: + +SnowflakeTag +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SnowflakeTag + :members: diff --git a/docs/asset/soda.rst b/docs/asset/soda.rst new file mode 100644 index 000000000..6a73eec20 --- /dev/null +++ b/docs/asset/soda.rst @@ -0,0 +1,10 @@ +.. _soda: + +Soda +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Soda + :members: diff --git a/docs/asset/sodacheck.rst b/docs/asset/sodacheck.rst new file mode 100644 index 000000000..2a4dd7bd3 --- /dev/null +++ b/docs/asset/sodacheck.rst @@ -0,0 +1,10 @@ +.. _sodacheck: + +SodaCheck +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SodaCheck + :members: diff --git a/docs/asset/sql.rst b/docs/asset/sql.rst new file mode 100644 index 000000000..8baa7717e --- /dev/null +++ b/docs/asset/sql.rst @@ -0,0 +1,10 @@ +.. _sql: + +SQL +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: SQL + :members: diff --git a/docs/asset/table.rst b/docs/asset/table.rst new file mode 100644 index 000000000..06cae5ed6 --- /dev/null +++ b/docs/asset/table.rst @@ -0,0 +1,10 @@ +.. _table: + +Table +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Table + :members: diff --git a/docs/asset/tableau.rst b/docs/asset/tableau.rst new file mode 100644 index 000000000..31873dcd7 --- /dev/null +++ b/docs/asset/tableau.rst @@ -0,0 +1,10 @@ +.. _tableau: + +Tableau +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Tableau + :members: diff --git a/docs/asset/tableaucalculatedfield.rst b/docs/asset/tableaucalculatedfield.rst new file mode 100644 index 000000000..84ab9f6b5 --- /dev/null +++ b/docs/asset/tableaucalculatedfield.rst @@ -0,0 +1,10 @@ +.. _tableaucalculatedfield: + +TableauCalculatedField +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauCalculatedField + :members: diff --git a/docs/asset/tableaudashboard.rst b/docs/asset/tableaudashboard.rst new file mode 100644 index 000000000..471c4937f --- /dev/null +++ b/docs/asset/tableaudashboard.rst @@ -0,0 +1,10 @@ +.. _tableaudashboard: + +TableauDashboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauDashboard + :members: diff --git a/docs/asset/tableaudatasource.rst b/docs/asset/tableaudatasource.rst new file mode 100644 index 000000000..ba8677500 --- /dev/null +++ b/docs/asset/tableaudatasource.rst @@ -0,0 +1,10 @@ +.. _tableaudatasource: + +TableauDatasource +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauDatasource + :members: diff --git a/docs/asset/tableaudatasourcefield.rst b/docs/asset/tableaudatasourcefield.rst new file mode 100644 index 000000000..0e005a499 --- /dev/null +++ b/docs/asset/tableaudatasourcefield.rst @@ -0,0 +1,10 @@ +.. _tableaudatasourcefield: + +TableauDatasourceField +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauDatasourceField + :members: diff --git a/docs/asset/tableauflow.rst b/docs/asset/tableauflow.rst new file mode 100644 index 000000000..af60d55eb --- /dev/null +++ b/docs/asset/tableauflow.rst @@ -0,0 +1,10 @@ +.. _tableauflow: + +TableauFlow +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauFlow + :members: diff --git a/docs/asset/tableaumetric.rst b/docs/asset/tableaumetric.rst new file mode 100644 index 000000000..624519a51 --- /dev/null +++ b/docs/asset/tableaumetric.rst @@ -0,0 +1,10 @@ +.. _tableaumetric: + +TableauMetric +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauMetric + :members: diff --git a/docs/asset/tableauproject.rst b/docs/asset/tableauproject.rst new file mode 100644 index 000000000..6456a22b1 --- /dev/null +++ b/docs/asset/tableauproject.rst @@ -0,0 +1,10 @@ +.. _tableauproject: + +TableauProject +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauProject + :members: diff --git a/docs/asset/tableausite.rst b/docs/asset/tableausite.rst new file mode 100644 index 000000000..bd600966f --- /dev/null +++ b/docs/asset/tableausite.rst @@ -0,0 +1,10 @@ +.. _tableausite: + +TableauSite +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauSite + :members: diff --git a/docs/asset/tableauworkbook.rst b/docs/asset/tableauworkbook.rst new file mode 100644 index 000000000..dc5009de5 --- /dev/null +++ b/docs/asset/tableauworkbook.rst @@ -0,0 +1,10 @@ +.. _tableauworkbook: + +TableauWorkbook +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauWorkbook + :members: diff --git a/docs/asset/tableauworksheet.rst b/docs/asset/tableauworksheet.rst new file mode 100644 index 000000000..e36a9e0da --- /dev/null +++ b/docs/asset/tableauworksheet.rst @@ -0,0 +1,10 @@ +.. _tableauworksheet: + +TableauWorksheet +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TableauWorksheet + :members: diff --git a/docs/asset/tablepartition.rst b/docs/asset/tablepartition.rst new file mode 100644 index 000000000..6d997da7a --- /dev/null +++ b/docs/asset/tablepartition.rst @@ -0,0 +1,10 @@ +.. _tablepartition: + +TablePartition +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: TablePartition + :members: diff --git a/docs/asset/tag.rst b/docs/asset/tag.rst new file mode 100644 index 000000000..0c00818b5 --- /dev/null +++ b/docs/asset/tag.rst @@ -0,0 +1,10 @@ +.. _tag: + +Tag +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Tag + :members: diff --git a/docs/asset/thoughtspot.rst b/docs/asset/thoughtspot.rst new file mode 100644 index 000000000..00aebf75f --- /dev/null +++ b/docs/asset/thoughtspot.rst @@ -0,0 +1,10 @@ +.. _thoughtspot: + +Thoughtspot +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: Thoughtspot + :members: diff --git a/docs/asset/thoughtspotanswer.rst b/docs/asset/thoughtspotanswer.rst new file mode 100644 index 000000000..dee47688d --- /dev/null +++ b/docs/asset/thoughtspotanswer.rst @@ -0,0 +1,10 @@ +.. _thoughtspotanswer: + +ThoughtspotAnswer +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ThoughtspotAnswer + :members: diff --git a/docs/asset/thoughtspotdashlet.rst b/docs/asset/thoughtspotdashlet.rst new file mode 100644 index 000000000..d5e2f2062 --- /dev/null +++ b/docs/asset/thoughtspotdashlet.rst @@ -0,0 +1,10 @@ +.. _thoughtspotdashlet: + +ThoughtspotDashlet +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ThoughtspotDashlet + :members: diff --git a/docs/asset/thoughtspotliveboard.rst b/docs/asset/thoughtspotliveboard.rst new file mode 100644 index 000000000..23dfb9951 --- /dev/null +++ b/docs/asset/thoughtspotliveboard.rst @@ -0,0 +1,10 @@ +.. _thoughtspotliveboard: + +ThoughtspotLiveboard +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: ThoughtspotLiveboard + :members: diff --git a/docs/asset/view.rst b/docs/asset/view.rst new file mode 100644 index 000000000..bef9fe04b --- /dev/null +++ b/docs/asset/view.rst @@ -0,0 +1,10 @@ +.. _view: + +View +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: View + :members: diff --git a/docs/assets.rst b/docs/assets.rst new file mode 100644 index 000000000..010c42a4b --- /dev/null +++ b/docs/assets.rst @@ -0,0 +1,208 @@ +.. _assets: + +Assets +====== + +You can interact with all of the following different kinds of assets: + +.. toctree:: + :maxdepth: 1 + + asset/adls + asset/adlsaccount + asset/adlscontainer + asset/adlsobject + asset/api + asset/apipath + asset/apispec + asset/aws + asset/accesscontrol + asset/airflow + asset/airflowdag + asset/airflowtask + asset/asset + asset/atlasglossary + asset/atlasglossarycategory + asset/atlasglossaryterm + asset/atlasserver + asset/authpolicy + asset/authservice + asset/azure + asset/azureeventhub + asset/azureeventhubconsumergroup + asset/bi + asset/biprocess + asset/badge + asset/catalog + asset/cloud + asset/collection + asset/column + asset/columnprocess + asset/connection + asset/dataquality + asset/dataset + asset/datastudio + asset/datastudioasset + asset/database + asset/dbt + asset/dbtcolumnprocess + asset/dbtmetric + asset/dbtmodel + asset/dbtmodelcolumn + asset/dbtprocess + asset/dbtsource + asset/dbttag + asset/dbttest + asset/eventstore + asset/file + asset/folder + asset/function + asset/gcs + asset/gcsbucket + asset/gcsobject + asset/google + asset/infrastructure + asset/insight + asset/kafka + asset/kafkaconsumergroup + asset/kafkatopic + asset/link + asset/looker + asset/lookerdashboard + asset/lookerexplore + asset/lookerfield + asset/lookerfolder + asset/lookerlook + asset/lookermodel + asset/lookerproject + asset/lookerquery + asset/lookertile + asset/lookerview + asset/mcincident + asset/mcmonitor + asset/materialisedview + asset/matillion + asset/matillioncomponent + asset/matilliongroup + asset/matillionjob + asset/matillionproject + asset/metabase + asset/metabasecollection + asset/metabasedashboard + asset/metabasequestion + asset/metric + asset/microstrategy + asset/microstrategyattribute + asset/microstrategycube + asset/microstrategydocument + asset/microstrategydossier + asset/microstrategyfact + asset/microstrategymetric + asset/microstrategyproject + asset/microstrategyreport + asset/microstrategyvisualization + asset/mode + asset/modechart + asset/modecollection + asset/modequery + asset/modereport + asset/modeworkspace + asset/mongodb + asset/mongodbcollection + asset/mongodbdatabase + asset/montecarlo + asset/namespace + asset/nosql + asset/objectstore + asset/persona + asset/powerbi + asset/powerbicolumn + asset/powerbidashboard + asset/powerbidataflow + asset/powerbidataset + asset/powerbidatasource + asset/powerbimeasure + asset/powerbipage + asset/powerbireport + asset/powerbitable + asset/powerbitile + asset/powerbiworkspace + asset/preset + asset/presetchart + asset/presetdashboard + asset/presetdataset + asset/presetworkspace + asset/procedure + asset/process + asset/processexecution + asset/purpose + asset/qlik + asset/qlikapp + asset/qlikchart + asset/qlikdataset + asset/qliksheet + asset/qlikspace + asset/qlikstream + asset/query + asset/quicksight + asset/quicksightanalysis + asset/quicksightanalysisvisual + asset/quicksightdashboard + asset/quicksightdashboardvisual + asset/quicksightdataset + asset/quicksightdatasetfield + asset/quicksightfolder + asset/readme + asset/readmetemplate + asset/redash + asset/redashdashboard + asset/redashquery + asset/redashvisualization + asset/referenceable + asset/resource + asset/s3 + asset/s3bucket + asset/s3object + asset/sql + asset/saas + asset/salesforce + asset/salesforcedashboard + asset/salesforcefield + asset/salesforceobject + asset/salesforceorganization + asset/salesforcereport + asset/schema + asset/schemaregistry + asset/schemaregistrysubject + asset/sigma + asset/sigmadataelement + asset/sigmadataelementfield + asset/sigmadataset + asset/sigmadatasetcolumn + asset/sigmapage + asset/sigmaworkbook + asset/snowflakedynamictable + asset/snowflakepipe + asset/snowflakestream + asset/snowflaketag + asset/soda + asset/sodacheck + asset/table + asset/tablepartition + asset/tableau + asset/tableaucalculatedfield + asset/tableaudashboard + asset/tableaudatasource + asset/tableaudatasourcefield + asset/tableauflow + asset/tableaumetric + asset/tableauproject + asset/tableausite + asset/tableauworkbook + asset/tableauworksheet + asset/tag + asset/thoughtspot + asset/thoughtspotanswer + asset/thoughtspotdashlet + asset/thoughtspotliveboard + asset/view diff --git a/docs/cache/atlan_tag_cache.rst b/docs/cache/atlan_tag_cache.rst new file mode 100644 index 000000000..625478add --- /dev/null +++ b/docs/cache/atlan_tag_cache.rst @@ -0,0 +1,10 @@ +.. _atlan_tag_cache: + +AtlanTagCache +============= + +.. module:: pyatlan.cache.atlan_tag_cache + :no-index: + +.. autoclass:: AtlanTagCache + :inherited-members: diff --git a/docs/cache/custom_metadata_cache.rst b/docs/cache/custom_metadata_cache.rst new file mode 100644 index 000000000..315f434ee --- /dev/null +++ b/docs/cache/custom_metadata_cache.rst @@ -0,0 +1,10 @@ +.. _custom_metadata_cache: + +CustomMetadataCache +=================== + +.. module:: pyatlan.cache.custom_metadata_cache + :no-index: + +.. autoclass:: CustomMetadataCache + :inherited-members: diff --git a/docs/cache/enum_cache.rst b/docs/cache/enum_cache.rst new file mode 100644 index 000000000..9f3586a73 --- /dev/null +++ b/docs/cache/enum_cache.rst @@ -0,0 +1,10 @@ +.. _enum_cache: + +EnumCache +========= + +.. module:: pyatlan.cache.enum_cache + :no-index: + +.. autoclass:: EnumCache + :inherited-members: diff --git a/docs/cache/group_cache.rst b/docs/cache/group_cache.rst new file mode 100644 index 000000000..42fe6dda3 --- /dev/null +++ b/docs/cache/group_cache.rst @@ -0,0 +1,10 @@ +.. _group_cache: + +GroupCache +========== + +.. module:: pyatlan.cache.group_cache + :no-index: + +.. autoclass:: GroupCache + :inherited-members: diff --git a/docs/cache/role_cache.rst b/docs/cache/role_cache.rst new file mode 100644 index 000000000..2724333be --- /dev/null +++ b/docs/cache/role_cache.rst @@ -0,0 +1,10 @@ +.. _role_cache: + +RoleCache +========= + +.. module:: pyatlan.cache.role_cache + :no-index: + +.. autoclass:: RoleCache + :inherited-members: diff --git a/docs/cache/user_cache.rst b/docs/cache/user_cache.rst new file mode 100644 index 000000000..7eaf0671d --- /dev/null +++ b/docs/cache/user_cache.rst @@ -0,0 +1,10 @@ +.. _user_cache: + +UserCache +========= + +.. module:: pyatlan.cache.user_cache + :no-index: + +.. autoclass:: UserCache + :inherited-members: diff --git a/docs/caches.rst b/docs/caches.rst new file mode 100644 index 000000000..0c4165fc7 --- /dev/null +++ b/docs/caches.rst @@ -0,0 +1,16 @@ +.. _caches: + +Caches +====== + +Pyatlan caches frequently used information that requires translation from Atlan: + +.. toctree:: + :maxdepth: 1 + + cache/atlan_tag_cache + cache/custom_metadata_cache + cache/enum_cache + cache/group_cache + cache/role_cache + cache/user_cache diff --git a/docs/client.rst b/docs/client.rst new file mode 100644 index 000000000..daa0980ad --- /dev/null +++ b/docs/client.rst @@ -0,0 +1,13 @@ +.. _client: + +Atlan Client Interface +====================== + +.. module:: pyatlan.client.atlan + :no-index: + +All the methods you can use to interact with Atlan using pyatlan. + +.. autoclass:: AtlanClient + :members: + :inherited-members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..fbd259c54 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,41 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +import os +import sys + +sys.path.insert(0, os.path.abspath("..")) + +import pyatlan # noqa: F401,E402 + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = "pyatlan" +copyright = "2023, Atlan Pte. Ltd." +author = "Ernest Hill, Chris Grote, Karanjot Singh" + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.viewcode", + "sphinx.ext.autosummary", +] + +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "furo" +html_static_path = ["_static"] + +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), +} diff --git a/docs/events.rst b/docs/events.rst new file mode 100644 index 000000000..a351ea03d --- /dev/null +++ b/docs/events.rst @@ -0,0 +1,17 @@ +.. _events: + +Events +============== + +Interfaces to simplify the implementation of event-handling using pyatlan: + +AtlanEventHandler +----------------- + +An interface you can implement to split the overall functionality required for an event processor down into small pieces: + +.. module:: pyatlan.events.atlan_event_handler + :no-index: + +.. autoclass:: AtlanEventHandler + :inherited-members: diff --git a/docs/exceptions.rst b/docs/exceptions.rst new file mode 100644 index 000000000..722b4f858 --- /dev/null +++ b/docs/exceptions.rst @@ -0,0 +1,20 @@ +.. _exceptions: + +Error Handling +============== + +.. module:: pyatlan.errors + :no-index: + +All error-handling is done through one of these: + +.. autoexception:: AtlanError +.. autoexception:: ApiConnectionError +.. autoexception:: NotFoundError +.. autoexception:: InvalidRequestError +.. autoexception:: ApiError +.. autoexception:: AuthenticationError +.. autoexception:: PermissionError +.. autoexception:: ConflictError +.. autoexception:: RateLimitError +.. autoexception:: LogicError diff --git a/docs/field/boolean_field.rst b/docs/field/boolean_field.rst new file mode 100644 index 000000000..f77932f98 --- /dev/null +++ b/docs/field/boolean_field.rst @@ -0,0 +1,10 @@ +.. _boolean_field: + +BooleanField +============ + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: BooleanField + :inherited-members: diff --git a/docs/field/custom_metadata_field.rst b/docs/field/custom_metadata_field.rst new file mode 100644 index 000000000..fc73a098a --- /dev/null +++ b/docs/field/custom_metadata_field.rst @@ -0,0 +1,10 @@ +.. _custom_metadata_field: + +CustomMetadataField +=================== + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: CustomMetadataField + :inherited-members: diff --git a/docs/field/keyword_field.rst b/docs/field/keyword_field.rst new file mode 100644 index 000000000..ef7d128d5 --- /dev/null +++ b/docs/field/keyword_field.rst @@ -0,0 +1,10 @@ +.. _keyword_field: + +KeywordField +============ + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: KeywordField + :inherited-members: diff --git a/docs/field/keyword_text_field.rst b/docs/field/keyword_text_field.rst new file mode 100644 index 000000000..fbb9cca9b --- /dev/null +++ b/docs/field/keyword_text_field.rst @@ -0,0 +1,10 @@ +.. _keyword_text_field: + +KeywordTextField +================ + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: KeywordTextField + :inherited-members: diff --git a/docs/field/keyword_text_stemmed_field.rst b/docs/field/keyword_text_stemmed_field.rst new file mode 100644 index 000000000..df5c88c0b --- /dev/null +++ b/docs/field/keyword_text_stemmed_field.rst @@ -0,0 +1,10 @@ +.. _keyword_text_stemmed_field: + +KeywordTextStemmedField +======================= + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: KeywordTextStemmedField + :inherited-members: diff --git a/docs/field/numeric_field.rst b/docs/field/numeric_field.rst new file mode 100644 index 000000000..358a54b92 --- /dev/null +++ b/docs/field/numeric_field.rst @@ -0,0 +1,10 @@ +.. _numeric_field: + +NumericField +============ + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: NumericField + :inherited-members: diff --git a/docs/field/numeric_rank_field.rst b/docs/field/numeric_rank_field.rst new file mode 100644 index 000000000..5982abbc3 --- /dev/null +++ b/docs/field/numeric_rank_field.rst @@ -0,0 +1,10 @@ +.. _numeric_rank_field: + +NumericRankField +================ + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: NumericRankField + :inherited-members: diff --git a/docs/field/relation_field.rst b/docs/field/relation_field.rst new file mode 100644 index 000000000..e177416d9 --- /dev/null +++ b/docs/field/relation_field.rst @@ -0,0 +1,10 @@ +.. _relation_field: + +RelationField +============= + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: RelationField + :inherited-members: diff --git a/docs/field/searchable_field.rst b/docs/field/searchable_field.rst new file mode 100644 index 000000000..86d722aba --- /dev/null +++ b/docs/field/searchable_field.rst @@ -0,0 +1,10 @@ +.. _searchable_field: + +SearchableField +=============== + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: SearchableField + :inherited-members: diff --git a/docs/field/text_field.rst b/docs/field/text_field.rst new file mode 100644 index 000000000..c6aba49c7 --- /dev/null +++ b/docs/field/text_field.rst @@ -0,0 +1,10 @@ +.. _text_field: + +TextField +========= + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: TextField + :inherited-members: diff --git a/docs/fields.rst b/docs/fields.rst new file mode 100644 index 000000000..ee1327cb5 --- /dev/null +++ b/docs/fields.rst @@ -0,0 +1,31 @@ +.. _fields: + +Fields +============== + +Fields dictate how information can be searched in Atlan using pyatlan: + +AtlanField +---------- + +.. module:: pyatlan.model.fields.atlan_fields + :no-index: + +.. autoclass:: AtlanField + :inherited-members: + +Subclasses: + +.. toctree:: + :maxdepth: 1 + + field/relation_field + field/searchable_field + field/boolean_field + field/keyword_field + field/text_field + field/numeric_field + field/numeric_rank_field + field/keyword_text_field + field/keyword_text_stemmed_field + field/custom_metadata_field diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..594354ef8 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,26 @@ +.. pyatlan documentation master file, created by + sphinx-quickstart on Tue Sep 12 22:47:19 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +pyatlan +======= + +Most methods you are likely to use integration with or automating things in Atlan are available in the client interface. Inevitably you'll be dealing with some (or many) different kinds of assets as part of your code, too. + +.. toctree:: + :maxdepth: 1 + + client + assets + +For the complete reference on deeper topics: + +.. toctree:: + :maxdepth: 1 + + other_models + exceptions + caches + fields + events diff --git a/docs/other_model/atlan_image.rst b/docs/other_model/atlan_image.rst new file mode 100644 index 000000000..b7bc6e2e8 --- /dev/null +++ b/docs/other_model/atlan_image.rst @@ -0,0 +1,10 @@ +.. _atlan_image: + +Atlan image +=========== + +.. module:: pyatlan.model.atlan_image + :no-index: + +.. autoclass:: AtlanImage + :members: diff --git a/docs/other_model/core.rst b/docs/other_model/core.rst new file mode 100644 index 000000000..7546b5423 --- /dev/null +++ b/docs/other_model/core.rst @@ -0,0 +1,31 @@ +.. _core: + +Core model +========== + +.. module:: pyatlan.model.core + :no-index: + +.. autoclass:: AtlanTagName + :members: + +.. autoclass:: AtlanTag + :members: + +.. autoclass:: AtlanTags + :members: + +.. autoclass:: Announcement + :members: + +.. autoclass:: AssetRequest + :members: + +.. autoclass:: AssetResponse + :members: + +.. autoclass:: BulkRequest + :members: + +.. autoclass:: SearchRequest + :members: diff --git a/docs/other_model/custom_metadata.rst b/docs/other_model/custom_metadata.rst new file mode 100644 index 000000000..6151e1f88 --- /dev/null +++ b/docs/other_model/custom_metadata.rst @@ -0,0 +1,16 @@ +.. _custom_metadata: + +Custom metadata +=============== + +.. module:: pyatlan.model.custom_metadata + :no-index: + +.. autoclass:: CustomMetadataDict + :members: + +.. autoclass:: CustomMetadataProxy + :members: + +.. autoclass:: CustomMetadataRequest + :members: diff --git a/docs/other_model/group.rst b/docs/other_model/group.rst new file mode 100644 index 000000000..0593889ed --- /dev/null +++ b/docs/other_model/group.rst @@ -0,0 +1,10 @@ +.. _group: + +Group +===== + +.. module:: pyatlan.model.group + :no-index: + +.. autoclass:: AtlanGroup + :members: diff --git a/docs/other_model/keycloak_events.rst b/docs/other_model/keycloak_events.rst new file mode 100644 index 000000000..4b4c5af53 --- /dev/null +++ b/docs/other_model/keycloak_events.rst @@ -0,0 +1,13 @@ +.. _keycloak_events: + +Keycloak events +=============== + +.. module:: pyatlan.model.keycloak_events + :no-index: + +.. autoclass:: KeycloakEvent + :members: + +.. autoclass:: AdminEvent + :members: diff --git a/docs/other_model/lineage.rst b/docs/other_model/lineage.rst new file mode 100644 index 000000000..f1cb9b576 --- /dev/null +++ b/docs/other_model/lineage.rst @@ -0,0 +1,25 @@ +.. _lineage: + +Lineage +======= + +.. module:: pyatlan.model.lineage + :no-index: + +.. autoclass:: LineageGraph + :members: + +.. autoclass:: LineageListRequest + :members: + +.. autoclass:: EntityFilter + :members: + +.. autoclass:: FilterList + :members: + +.. autoclass:: LineageRequest + :members: + +.. autoclass:: LineageResponse + :members: diff --git a/docs/other_model/role.rst b/docs/other_model/role.rst new file mode 100644 index 000000000..b83cb4fad --- /dev/null +++ b/docs/other_model/role.rst @@ -0,0 +1,10 @@ +.. _role: + +Role +==== + +.. module:: pyatlan.model.role + :no-index: + +.. autoclass:: AtlanRole + :members: diff --git a/docs/other_model/typedef.rst b/docs/other_model/typedef.rst new file mode 100644 index 000000000..a210b9c4d --- /dev/null +++ b/docs/other_model/typedef.rst @@ -0,0 +1,37 @@ +.. _typedef: + +TypeDef +======= + +.. module:: pyatlan.model.typedef + :no-index: + +.. autoclass:: TypeDef + :members: + +.. autoclass:: AtlanTagDef + :members: + +.. autoclass:: CustomMetadataDef + :members: + +.. autoclass:: AttributeDef + :members: + +.. autoclass:: EnumDef + :members: + +.. autoclass:: RelationshipAttributeDef + :members: + +.. autoclass:: StructDef + :members: + +.. autoclass:: EntityDef + :members: + +.. autoclass:: RelationshipDef + :members: + +.. autoclass:: TypeDefResponse + :members: diff --git a/docs/other_model/user.rst b/docs/other_model/user.rst new file mode 100644 index 000000000..2f9c97495 --- /dev/null +++ b/docs/other_model/user.rst @@ -0,0 +1,10 @@ +.. _user: + +User +==== + +.. module:: pyatlan.model.user + :no-index: + +.. autoclass:: AtlanUser + :members: diff --git a/docs/other_models.rst b/docs/other_models.rst new file mode 100644 index 000000000..2d16a11c6 --- /dev/null +++ b/docs/other_models.rst @@ -0,0 +1,19 @@ +.. _other_models: + +Other models +============ + +Aside from assets (likely the majority of what you will interact with), there are these additional models: + +.. toctree:: + :maxdepth: 1 + + other_model/core + other_model/custom_metadata + other_model/user + other_model/group + other_model/role + other_model/keycloak_events + other_model/lineage + other_model/typedef + other_model/atlan_image diff --git a/pyatlan/generator/class_generator.py b/pyatlan/generator/class_generator.py index e51cb9d9f..7f75faea0 100644 --- a/pyatlan/generator/class_generator.py +++ b/pyatlan/generator/class_generator.py @@ -75,6 +75,7 @@ ASSETS_DIR = PARENT.parent / "model" / "assets" MODEL_DIR = PARENT.parent / "model" DOCS_DIR = PARENT.parent / "documentation" +SPHINX_DIR = PARENT.parent.parent / "docs" def get_type(type_: str): @@ -712,6 +713,35 @@ def render_docs_entity_relationships(self, entity_defs): ) as doc: doc.write(content) + def render_sphinx_docs(self, entity_defs): + template = self.environment.get_template( + "documentation/sphinx_asset_index.jinja2" + ) + to_include = [] + for entity_def in entity_defs: + if not entity_def.name.startswith("__"): + to_include.append(entity_def) + sorted_defs = sorted(to_include, key=(lambda x: x.name)) + content = template.render( + { + "entity_defs": sorted_defs, + } + ) + with (SPHINX_DIR / "assets.rst").open("w") as doc: + doc.write(content) + + template = self.environment.get_template("documentation/sphinx_asset.jinja2") + for entity_def in sorted_defs: + content = template.render( + { + "entity_def_name": entity_def.name, + } + ) + with (SPHINX_DIR / "asset" / f"{entity_def.name.lower()}.rst").open( + "w" + ) as doc: + doc.write(content) + class KeyValue(NamedTuple): key: str @@ -762,3 +792,4 @@ def create(cls, enum_defs): generator.render_docs_struct_snippets(type_defs.struct_defs) generator.render_docs_entity_properties(type_defs.entity_defs) generator.render_docs_entity_relationships(type_defs.entity_defs) + generator.render_sphinx_docs(type_defs.entity_defs) diff --git a/pyatlan/generator/templates/documentation/sphinx_asset.jinja2 b/pyatlan/generator/templates/documentation/sphinx_asset.jinja2 new file mode 100644 index 000000000..0dee52fd6 --- /dev/null +++ b/pyatlan/generator/templates/documentation/sphinx_asset.jinja2 @@ -0,0 +1,10 @@ +.. _{{ entity_def_name | lower }}: + +{{ entity_def_name }} +============= + +.. module:: pyatlan.model.assets + :no-index: + +.. autoclass:: {{ entity_def_name }} + :members: diff --git a/pyatlan/generator/templates/documentation/sphinx_asset_index.jinja2 b/pyatlan/generator/templates/documentation/sphinx_asset_index.jinja2 new file mode 100644 index 000000000..1b688c350 --- /dev/null +++ b/pyatlan/generator/templates/documentation/sphinx_asset_index.jinja2 @@ -0,0 +1,12 @@ +.. _assets: + +Assets +====== + +You can interact with all of the following different kinds of assets: + +.. toctree:: + :maxdepth: 1 +{% for entity_def in entity_defs %} + asset/{{ entity_def.name | lower }} +{%- endfor %} diff --git a/requirements-dev.txt b/requirements-dev.txt index baafe3329..0d92fe480 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -12,3 +12,4 @@ twine==4.0.2 types-retry==0.9.9.3 nanoid==2.0.0 networkx-stubs==0.0.1 +sphinx=7.2.5