Initial Sphinx-based doc generation

Signed-off-by: Christopher Grote <[email protected]>

.gitignore

@@ -1,4 +1,5 @@
 .idea/
+.vscode/
 
 # dotenv
 .env
@@ -54,3 +55,7 @@ examples/
 
 # Generated documentation
 pyatlan/documentation/*.md
+
+# Sphinx
+docs/_build/
+docs/generated/

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)

docs/asset/accesscontrol.rst

@@ -0,0 +1,10 @@
+.. _accesscontrol:
+
+AccessControl
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AccessControl
+    :members:

docs/asset/adls.rst

@@ -0,0 +1,10 @@
+.. _adls:
+
+ADLS
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: ADLS
+    :members:

docs/asset/adlsaccount.rst

@@ -0,0 +1,10 @@
+.. _adlsaccount:
+
+ADLSAccount
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: ADLSAccount
+    :members:

docs/asset/adlscontainer.rst

@@ -0,0 +1,10 @@
+.. _adlscontainer:
+
+ADLSContainer
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: ADLSContainer
+    :members:

docs/asset/adlsobject.rst

@@ -0,0 +1,10 @@
+.. _adlsobject:
+
+ADLSObject
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: ADLSObject
+    :members:

docs/asset/airflow.rst

@@ -0,0 +1,10 @@
+.. _airflow:
+
+Airflow
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Airflow
+    :members:

docs/asset/airflowdag.rst

@@ -0,0 +1,10 @@
+.. _airflowdag:
+
+AirflowDag
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AirflowDag
+    :members:

docs/asset/airflowtask.rst

@@ -0,0 +1,10 @@
+.. _airflowtask:
+
+AirflowTask
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AirflowTask
+    :members:

docs/asset/api.rst

@@ -0,0 +1,10 @@
+.. _api:
+
+API
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: API
+    :members:

docs/asset/apipath.rst

@@ -0,0 +1,10 @@
+.. _apipath:
+
+APIPath
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: APIPath
+    :members:

docs/asset/apispec.rst

@@ -0,0 +1,10 @@
+.. _apispec:
+
+APISpec
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: APISpec
+    :members:

docs/asset/asset.rst

@@ -0,0 +1,10 @@
+.. _asset:
+
+Asset
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Asset
+    :members:

docs/asset/atlasglossary.rst

@@ -0,0 +1,10 @@
+.. _atlasglossary:
+
+AtlasGlossary
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AtlasGlossary
+    :members:

docs/asset/atlasglossarycategory.rst

@@ -0,0 +1,10 @@
+.. _atlasglossarycategory:
+
+AtlasGlossaryCategory
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AtlasGlossaryCategory
+    :members:

docs/asset/atlasglossaryterm.rst

@@ -0,0 +1,10 @@
+.. _atlasglossaryterm:
+
+AtlasGlossaryTerm
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AtlasGlossaryTerm
+    :members:

docs/asset/atlasserver.rst

@@ -0,0 +1,10 @@
+.. _atlasserver:
+
+AtlasServer
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AtlasServer
+    :members:

docs/asset/authpolicy.rst

@@ -0,0 +1,10 @@
+.. _authpolicy:
+
+AuthPolicy
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AuthPolicy
+    :members:

docs/asset/authservice.rst

@@ -0,0 +1,10 @@
+.. _authservice:
+
+AuthService
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AuthService
+    :members:

docs/asset/aws.rst

@@ -0,0 +1,10 @@
+.. _aws:
+
+AWS
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AWS
+    :members:

docs/asset/azure.rst

@@ -0,0 +1,10 @@
+.. _azure:
+
+Azure
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Azure
+    :members:

docs/asset/azureeventhub.rst

@@ -0,0 +1,10 @@
+.. _azureeventhub:
+
+AzureEventHub
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AzureEventHub
+    :members:

docs/asset/azureeventhubconsumergroup.rst

@@ -0,0 +1,10 @@
+.. _azureeventhubconsumergroup:
+
+AzureEventHubConsumerGroup
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: AzureEventHubConsumerGroup
+    :members:

docs/asset/badge.rst

@@ -0,0 +1,10 @@
+.. _badge:
+
+Badge
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Badge
+    :members:

docs/asset/bi.rst

@@ -0,0 +1,10 @@
+.. _bi:
+
+BI
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: BI
+    :members:

docs/asset/biprocess.rst

@@ -0,0 +1,10 @@
+.. _biprocess:
+
+BIProcess
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: BIProcess
+    :members:

docs/asset/catalog.rst

@@ -0,0 +1,10 @@
+.. _catalog:
+
+Catalog
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Catalog
+    :members:

docs/asset/cloud.rst

@@ -0,0 +1,10 @@
+.. _cloud:
+
+Cloud
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Cloud
+    :members:

docs/asset/collection.rst

@@ -0,0 +1,10 @@
+.. _collection:
+
+Collection
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Collection
+    :members:

docs/asset/column.rst

@@ -0,0 +1,10 @@
+.. _column:
+
+Column
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Column
+    :members:

docs/asset/columnprocess.rst

@@ -0,0 +1,10 @@
+.. _columnprocess:
+
+ColumnProcess
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: ColumnProcess
+    :members:

docs/asset/connection.rst

@@ -0,0 +1,10 @@
+.. _connection:
+
+Connection
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Connection
+    :members:

docs/asset/database.rst

@@ -0,0 +1,10 @@
+.. _database:
+
+Database
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: Database
+    :members:

docs/asset/dataquality.rst

@@ -0,0 +1,10 @@
+.. _dataquality:
+
+DataQuality
+=============
+
+.. module:: pyatlan.model.assets
+    :no-index:
+
+.. autoclass:: DataQuality
+    :members: