CDK: Autogenerate reference docs

.gitignore

@@ -60,3 +60,6 @@ resources/examples/airflow/logs/*
 
 # Cloud Demo
 !airbyte-webapp/src/packages/cloud/data
+
+# Sphinx Docs
+_build

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: airbyte-cdk/python/reference_docs/_source/conf.py
+
+# Set the version of Python and requirements required to build your docs
+python:
+  version: "3.7"
+  install:
+    - method: pip
+      path: airbyte-cdk/python
+      extra_requirements:
+        - sphinx-docs

airbyte-cdk/python/reference_docs/Makefile

@@ -0,0 +1,23 @@
+# 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     = _source
+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)
+
+rst:
+	sphinx-apidoc -f -F -o $(SOURCEDIR)/api ../airbyte_cdk

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.destinations.rst

@@ -0,0 +1,21 @@
+airbyte\_cdk.destinations package
+=================================
+
+Submodules
+----------
+
+airbyte\_cdk.destinations.destination module
+--------------------------------------------
+
+.. automodule:: airbyte_cdk.destinations.destination
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.destinations
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.models.rst

@@ -0,0 +1,21 @@
+airbyte\_cdk.models package
+===========================
+
+Submodules
+----------
+
+airbyte\_cdk.models.airbyte\_protocol module
+--------------------------------------------
+
+.. automodule:: airbyte_cdk.models.airbyte_protocol
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.rst

@@ -0,0 +1,47 @@
+airbyte\_cdk package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   airbyte_cdk.destinations
+   airbyte_cdk.models
+   airbyte_cdk.sources
+
+Submodules
+----------
+
+airbyte\_cdk.connector module
+-----------------------------
+
+.. automodule:: airbyte_cdk.connector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.entrypoint module
+------------------------------
+
+.. automodule:: airbyte_cdk.entrypoint
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.logger module
+--------------------------
+
+.. automodule:: airbyte_cdk.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst

@@ -0,0 +1,29 @@
+airbyte\_cdk.sources.deprecated package
+=======================================
+
+Submodules
+----------
+
+airbyte\_cdk.sources.deprecated.base\_source module
+---------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.deprecated.base_source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.deprecated.client module
+---------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.deprecated.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources.deprecated
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.rst

@@ -0,0 +1,40 @@
+airbyte\_cdk.sources package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   airbyte_cdk.sources.deprecated
+   airbyte_cdk.sources.singer
+   airbyte_cdk.sources.streams
+   airbyte_cdk.sources.utils
+
+Submodules
+----------
+
+airbyte\_cdk.sources.abstract\_source module
+--------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.abstract_source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.source module
+----------------------------------
+
+.. automodule:: airbyte_cdk.sources.source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.singer.rst

@@ -0,0 +1,29 @@
+airbyte\_cdk.sources.singer package
+===================================
+
+Submodules
+----------
+
+airbyte\_cdk.sources.singer.singer\_helpers module
+--------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.singer.singer_helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.singer.source module
+-----------------------------------------
+
+.. automodule:: airbyte_cdk.sources.singer.source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources.singer
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst

@@ -0,0 +1,37 @@
+airbyte\_cdk.sources.streams.http.auth package
+==============================================
+
+Submodules
+----------
+
+airbyte\_cdk.sources.streams.http.auth.core module
+--------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.auth.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.streams.http.auth.oauth module
+---------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.auth.oauth
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.streams.http.auth.token module
+---------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.auth.token
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.auth
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst

@@ -0,0 +1,29 @@
+airbyte\_cdk.sources.streams.http.requests\_native\_auth package
+================================================================
+
+Submodules
+----------
+
+airbyte\_cdk.sources.streams.http.requests\_native\_auth.oauth module
+---------------------------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.requests_native_auth.oauth
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.streams.http.requests\_native\_auth.token module
+---------------------------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.requests_native_auth.token
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.requests_native_auth
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst

@@ -0,0 +1,46 @@
+airbyte\_cdk.sources.streams.http package
+=========================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   airbyte_cdk.sources.streams.http.auth
+   airbyte_cdk.sources.streams.http.requests_native_auth
+
+Submodules
+----------
+
+airbyte\_cdk.sources.streams.http.exceptions module
+---------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.streams.http.http module
+---------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.http
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+airbyte\_cdk.sources.streams.http.rate\_limiting module
+-------------------------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.http.rate_limiting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources.streams.http
+   :members:
+   :undoc-members:
+   :show-inheritance:

airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.sources.streams.rst

@@ -0,0 +1,29 @@
+airbyte\_cdk.sources.streams package
+====================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   airbyte_cdk.sources.streams.http
+
+Submodules
+----------
+
+airbyte\_cdk.sources.streams.core module
+----------------------------------------
+
+.. automodule:: airbyte_cdk.sources.streams.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: airbyte_cdk.sources.streams
+   :members:
+   :undoc-members:
+   :show-inheritance: