-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add reference docs for declarative source (#14501)
* generate pdoc * set python version to 3.8 * mimic doc * set the os * Revert "generate pdoc" This reverts commit 82bdeab. * add missing docs * add declarative to index * missing init files * generate rst files
- Loading branch information
Showing
28 changed files
with
711 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
airbyte-cdk/python/airbyte_cdk/sources/declarative/checks/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
3 changes: 3 additions & 0 deletions
3
airbyte-cdk/python/airbyte_cdk/sources/declarative/datetime/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
3 changes: 3 additions & 0 deletions
3
airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
3 changes: 3 additions & 0 deletions
3
airbyte-cdk/python/airbyte_cdk/sources/declarative/retrievers/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
3 changes: 3 additions & 0 deletions
3
airbyte-cdk/python/airbyte_cdk/sources/declarative/schema/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
3 changes: 3 additions & 0 deletions
3
airbyte-cdk/python/airbyte_cdk/sources/declarative/stream_slicers/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
...dk/python/reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.checks.check\_stream module | ||
------------------------------------------------------------ | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.checks.check_stream | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.checks.connection\_checker module | ||
------------------------------------------------------------------ | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.checks.connection_checker | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.checks | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
19 changes: 19 additions & 0 deletions
19
.../python/reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.datetime.min\_max\_datetime module | ||
------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.datetime.min_max_datetime | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.datetime | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
27 changes: 27 additions & 0 deletions
27
.../python/reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.decoders.decoder module | ||
-------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.decoders.decoder | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.decoders.json\_decoder module | ||
-------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.decoders.json_decoder | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.decoders | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
43 changes: 43 additions & 0 deletions
43
...ython/reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.extractors.http\_selector module | ||
----------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.extractors.http_selector | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.extractors.jello module | ||
-------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.extractors.jello | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.extractors.record\_filter module | ||
----------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.extractors.record_filter | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.extractors.record\_selector module | ||
------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.extractors.record_selector | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.extractors | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
51 changes: 51 additions & 0 deletions
51
...on/reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.interpolation.interpolated\_boolean module | ||
--------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.interpolation.interpolated_boolean | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.interpolation.interpolated\_mapping module | ||
--------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.interpolation.interpolated_mapping | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.interpolation.interpolated\_string module | ||
-------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.interpolation.interpolated_string | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.interpolation.interpolation module | ||
------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.interpolation.interpolation | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.interpolation.jinja module | ||
----------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.interpolation.jinja | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.interpolation | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
59 changes: 59 additions & 0 deletions
59
...k/python/reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.parsers.class\_types\_registry module | ||
---------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers.class_types_registry | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.parsers.config\_parser module | ||
-------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers.config_parser | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.parsers.default\_implementation\_registry module | ||
--------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers.default_implementation_registry | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.parsers.factory module | ||
------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers.factory | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.parsers.undefined\_reference\_exception module | ||
------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers.undefined_reference_exception | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.parsers.yaml\_parser module | ||
------------------------------------------------------------ | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers.yaml_parser | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.parsers | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
59 changes: 59 additions & 0 deletions
59
...ence_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.requesters.paginators.conditional\_paginator module | ||
------------------------------------------------------------------------------------ | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.conditional_paginator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.requesters.paginators.interpolated\_paginator module | ||
------------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.interpolated_paginator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.requesters.paginators.next\_page\_url\_paginator module | ||
---------------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.next_page_url_paginator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.requesters.paginators.no\_pagination module | ||
---------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.no_pagination | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.requesters.paginators.offset\_paginator module | ||
------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.offset_paginator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.requesters.paginators.paginator module | ||
----------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.paginator | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
27 changes: 27 additions & 0 deletions
27
...docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
|
||
Submodules | ||
---------- | ||
|
||
airbyte\_cdk.sources.declarative.requesters.request\_headers.interpolated\_request\_header\_provider module | ||
----------------------------------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.request_headers.interpolated_request_header_provider | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
airbyte\_cdk.sources.declarative.requesters.request\_headers.request\_header\_provider module | ||
--------------------------------------------------------------------------------------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.request_headers.request_header_provider | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: airbyte_cdk.sources.declarative.requesters.request_headers | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.