Skip to content

Commit

Permalink
add reference docs for declarative source (#14501)
Browse files Browse the repository at this point in the history
* 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
girarda authored Jul 8, 2022
1 parent 391e97f commit 1cf89c6
Show file tree
Hide file tree
Showing 28 changed files with 711 additions and 4 deletions.
9 changes: 5 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,18 @@
# Required
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.9"

# 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:
# TODO: this is a hack, CDK supports 3.9 but readthedocs only supports up to 3.8
# we should upgrade this whenever readthedocs is fixed
# manually verified the docs successfully generate
version: "3.8"
install:
- method: pip
path: airbyte-cdk/python
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
9 changes: 9 additions & 0 deletions airbyte-cdk/python/reference_docs/_source/api/airbyte_cdk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Subpackages
airbyte_cdk.destinations
airbyte_cdk.models
airbyte_cdk.sources
airbyte_cdk.utils

Submodules
----------
Expand All @@ -28,6 +29,14 @@ airbyte\_cdk.entrypoint module
:undoc-members:
:show-inheritance:

airbyte\_cdk.exception\_handler module
--------------------------------------

.. automodule:: airbyte_cdk.exception_handler
:members:
:undoc-members:
:show-inheritance:

airbyte\_cdk.logger module
--------------------------

Expand Down
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:
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:
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:
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:
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:
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:
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:
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:
Loading

0 comments on commit 1cf89c6

Please sign in to comment.