From 8f17ba174c98ac16adbdc506b1116b98b3248b64 Mon Sep 17 00:00:00 2001 From: Max Barnash Date: Wed, 4 Dec 2024 19:24:10 -0800 Subject: [PATCH] chore(docs): purge sphinx documentation and related dependencies --- poetry.lock | 301 +----------------- pyproject.toml | 5 +- reference_docs/Makefile | 23 -- .../_source/api/airbyte_cdk.destinations.rst | 19 -- .../_source/api/airbyte_cdk.models.rst | 19 -- reference_docs/_source/api/airbyte_cdk.rst | 54 ---- .../airbyte_cdk.sources.declarative.auth.rst | 27 -- ...airbyte_cdk.sources.declarative.checks.rst | 27 -- ...rbyte_cdk.sources.declarative.datetime.rst | 27 -- ...rbyte_cdk.sources.declarative.decoders.rst | 27 -- ...yte_cdk.sources.declarative.extractors.rst | 51 --- ..._cdk.sources.declarative.interpolation.rst | 59 ---- ...irbyte_cdk.sources.declarative.parsers.rst | 59 ---- ...ters.error_handlers.backoff_strategies.rst | 51 --- ....declarative.requesters.error_handlers.rst | 75 ----- ...rces.declarative.requesters.paginators.rst | 43 --- ...ative.requesters.paginators.strategies.rst | 43 --- ...declarative.requesters.request_headers.rst | 27 -- ...declarative.requesters.request_options.rst | 35 -- ...ources.declarative.requesters.retriers.rst | 27 -- ...yte_cdk.sources.declarative.requesters.rst | 45 --- ...yte_cdk.sources.declarative.retrievers.rst | 27 -- .../api/airbyte_cdk.sources.declarative.rst | 78 ----- ...airbyte_cdk.sources.declarative.schema.rst | 27 -- ...airbyte_cdk.sources.declarative.states.rst | 27 -- ...cdk.sources.declarative.stream_slicers.rst | 59 ---- ...dk.sources.declarative.transformations.rst | 35 -- .../api/airbyte_cdk.sources.deprecated.rst | 27 -- .../_source/api/airbyte_cdk.sources.rst | 47 --- .../api/airbyte_cdk.sources.singer.rst | 27 -- .../airbyte_cdk.sources.streams.http.auth.rst | 35 -- ...rces.streams.http.requests_native_auth.rst | 43 --- .../api/airbyte_cdk.sources.streams.http.rst | 44 --- .../api/airbyte_cdk.sources.streams.rst | 27 -- .../_source/api/airbyte_cdk.sources.utils.rst | 51 --- .../_source/api/airbyte_cdk.utils.rst | 35 -- reference_docs/_source/api/modules.rst | 7 - reference_docs/_source/conf.py | 66 ---- reference_docs/_source/index.rst | 36 --- .../_source/templates/master_doc.rst_t | 19 -- .../_source/templates/package.rst_t | 51 --- .../_static/img/airbyte_new_logo.svg | 5 - reference_docs/generate_rst_schema.py | 54 ---- sphinx-docs.md | 97 ------ 44 files changed, 8 insertions(+), 1960 deletions(-) delete mode 100644 reference_docs/Makefile delete mode 100644 reference_docs/_source/api/airbyte_cdk.destinations.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.models.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.strategies.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_options.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.retriers.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.retrievers.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.schema.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.states.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.stream_slicers.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.declarative.transformations.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.singer.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.streams.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.sources.utils.rst delete mode 100644 reference_docs/_source/api/airbyte_cdk.utils.rst delete mode 100644 reference_docs/_source/api/modules.rst delete mode 100644 reference_docs/_source/conf.py delete mode 100644 reference_docs/_source/index.rst delete mode 100644 reference_docs/_source/templates/master_doc.rst_t delete mode 100644 reference_docs/_source/templates/package.rst_t delete mode 100644 reference_docs/_static/img/airbyte_new_logo.svg delete mode 100755 reference_docs/generate_rst_schema.py delete mode 100644 sphinx-docs.md diff --git a/poetry.lock b/poetry.lock index b7b9736bf..07ddb189c 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand. [[package]] name = "aiohappyeyeballs" @@ -134,17 +134,6 @@ files = [ {file = "airbyte_protocol_models_dataclasses-0.14.1.tar.gz", hash = "sha256:f62a46556b82ea0d55de144983141639e8049d836dd4e0a9d7234c5b2e103c08"}, ] -[[package]] -name = "alabaster" -version = "0.7.16" -description = "A light, configurable Sphinx theme" -optional = true -python-versions = ">=3.9" -files = [ - {file = "alabaster-0.7.16-py3-none-any.whl", hash = "sha256:b46733c07dce03ae4e150330b975c75737fa60f0a7c591b6c8bf4928a28e2c92"}, - {file = "alabaster-0.7.16.tar.gz", hash = "sha256:75a8b99c28a5dad50dd7f8ccdd447a121ddb3892da9e53d1ca5cca3106d58d65"}, -] - [[package]] name = "annotated-types" version = "0.7.0" @@ -246,20 +235,6 @@ files = [ snappy = ["python-snappy"] zstandard = ["zstandard"] -[[package]] -name = "babel" -version = "2.16.0" -description = "Internationalization utilities" -optional = true -python-versions = ">=3.8" -files = [ - {file = "babel-2.16.0-py3-none-any.whl", hash = "sha256:368b5b98b37c06b7daf6696391c3240c938b37767d4584413e8438c5c435fa8b"}, - {file = "babel-2.16.0.tar.gz", hash = "sha256:d1f3554ca26605fe173f3de0c65f750f5a42f924499bf134de6423582298e316"}, -] - -[package.extras] -dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] - [[package]] name = "backoff" version = "2.2.1" @@ -930,17 +905,6 @@ files = [ marshmallow = ">=3.18.0,<4.0.0" typing-inspect = ">=0.4.0,<1" -[[package]] -name = "docutils" -version = "0.17.1" -description = "Docutils -- Python Documentation Utilities" -optional = true -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -files = [ - {file = "docutils-0.17.1-py2.py3-none-any.whl", hash = "sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61"}, - {file = "docutils-0.17.1.tar.gz", hash = "sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125"}, -] - [[package]] name = "dpath" version = "2.2.0" @@ -1427,17 +1391,6 @@ files = [ [package.extras] all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"] -[[package]] -name = "imagesize" -version = "1.4.1" -description = "Getting image size from png/jpeg/jpeg2000/gif file" -optional = true -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -files = [ - {file = "imagesize-1.4.1-py2.py3-none-any.whl", hash = "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b"}, - {file = "imagesize-1.4.1.tar.gz", hash = "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"}, -] - [[package]] name = "importlib-metadata" version = "6.11.0" @@ -4262,6 +4215,11 @@ files = [ {file = "scikit_learn-1.5.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f60021ec1574e56632be2a36b946f8143bf4e5e6af4a06d85281adc22938e0dd"}, {file = "scikit_learn-1.5.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:394397841449853c2290a32050382edaec3da89e35b3e03d6cc966aebc6a8ae6"}, {file = "scikit_learn-1.5.2-cp312-cp312-win_amd64.whl", hash = "sha256:57cc1786cfd6bd118220a92ede80270132aa353647684efa385a74244a41e3b1"}, + {file = "scikit_learn-1.5.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e9a702e2de732bbb20d3bad29ebd77fc05a6b427dc49964300340e4c9328b3f5"}, + {file = "scikit_learn-1.5.2-cp313-cp313-macosx_12_0_arm64.whl", hash = "sha256:b0768ad641981f5d3a198430a1d31c3e044ed2e8a6f22166b4d546a5116d7908"}, + {file = "scikit_learn-1.5.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:178ddd0a5cb0044464fc1bfc4cca5b1833bfc7bb022d70b05db8530da4bb3dd3"}, + {file = "scikit_learn-1.5.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f7284ade780084d94505632241bf78c44ab3b6f1e8ccab3d2af58e0e950f9c12"}, + {file = "scikit_learn-1.5.2-cp313-cp313-win_amd64.whl", hash = "sha256:b7b0f9a0b1040830d38c39b91b3a44e1b643f4b36e36567b80b7c6bd2202a27f"}, {file = "scikit_learn-1.5.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:757c7d514ddb00ae249832fe87100d9c73c6ea91423802872d9e74970a0e40b9"}, {file = "scikit_learn-1.5.2-cp39-cp39-macosx_12_0_arm64.whl", hash = "sha256:52788f48b5d8bca5c0736c175fa6bdaab2ef00a8f536cda698db61bd89c551c1"}, {file = "scikit_learn-1.5.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:643964678f4b5fbdc95cbf8aec638acc7aa70f5f79ee2cdad1eec3df4ba6ead8"}, @@ -4389,26 +4347,6 @@ files = [ attributes-doc = "*" typing-extensions = "*" -[[package]] -name = "setuptools" -version = "75.6.0" -description = "Easily download, build, install, upgrade, and uninstall Python packages" -optional = true -python-versions = ">=3.9" -files = [ - {file = "setuptools-75.6.0-py3-none-any.whl", hash = "sha256:ce74b49e8f7110f9bf04883b730f4765b774ef3ef28f722cce7c273d253aaf7d"}, - {file = "setuptools-75.6.0.tar.gz", hash = "sha256:8199222558df7c86216af4f84c30e9b34a61d8ba19366cc914424cdbd28252f6"}, -] - -[package.extras] -check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1)", "ruff (>=0.7.0)"] -core = ["importlib_metadata (>=6)", "jaraco.collections", "jaraco.functools (>=4)", "jaraco.text (>=3.7)", "more_itertools", "more_itertools (>=8.8)", "packaging", "packaging (>=24.2)", "platformdirs (>=4.2.2)", "tomli (>=2.0.1)", "wheel (>=0.43.0)"] -cover = ["pytest-cov"] -doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "pyproject-hooks (!=1.1)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier", "towncrier (<24.7)"] -enabler = ["pytest-enabler (>=2.2)"] -test = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "ini2toml[lite] (>=0.14)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "jaraco.test (>=5.5)", "packaging (>=24.2)", "pip (>=19.1)", "pyproject-hooks (!=1.1)", "pytest (>=6,!=8.1.*)", "pytest-home (>=0.5)", "pytest-perf", "pytest-subprocess", "pytest-timeout", "pytest-xdist (>=3)", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel (>=0.44.0)"] -type = ["importlib_metadata (>=7.0.2)", "jaraco.develop (>=7.21)", "mypy (>=1.12,<1.14)", "pytest-mypy"] - [[package]] name = "six" version = "1.16.0" @@ -4431,17 +4369,6 @@ files = [ {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"}, ] -[[package]] -name = "snowballstemmer" -version = "2.2.0" -description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." -optional = true -python-versions = "*" -files = [ - {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"}, - {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"}, -] - [[package]] name = "soupsieve" version = "2.6" @@ -4453,153 +4380,6 @@ files = [ {file = "soupsieve-2.6.tar.gz", hash = "sha256:e2e68417777af359ec65daac1057404a3c8a5455bb8abc36f1a9866ab1a51abb"}, ] -[[package]] -name = "sphinx" -version = "4.2.0" -description = "Python documentation generator" -optional = true -python-versions = ">=3.6" -files = [ - {file = "Sphinx-4.2.0-py3-none-any.whl", hash = "sha256:98a535c62a4fcfcc362528592f69b26f7caec587d32cd55688db580be0287ae0"}, - {file = "Sphinx-4.2.0.tar.gz", hash = "sha256:94078db9184491e15bce0a56d9186e0aec95f16ac20b12d00e06d4e36f1058a6"}, -] - -[package.dependencies] -alabaster = ">=0.7,<0.8" -babel = ">=1.3" -colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""} -docutils = ">=0.14,<0.18" -imagesize = "*" -Jinja2 = ">=2.3" -packaging = "*" -Pygments = ">=2.0" -requests = ">=2.5.0" -setuptools = "*" -snowballstemmer = ">=1.1" -sphinxcontrib-applehelp = "*" -sphinxcontrib-devhelp = "*" -sphinxcontrib-htmlhelp = ">=2.0.0" -sphinxcontrib-jsmath = "*" -sphinxcontrib-qthelp = "*" -sphinxcontrib-serializinghtml = ">=1.1.5" - -[package.extras] -docs = ["sphinxcontrib-websupport"] -lint = ["docutils-stubs", "flake8 (>=3.5.0)", "isort", "mypy (>=0.900)", "types-pkg-resources", "types-requests", "types-typed-ast"] -test = ["cython", "html5lib", "pytest", "pytest-cov", "typed-ast"] - -[[package]] -name = "sphinx-rtd-theme" -version = "1.0.0" -description = "Read the Docs theme for Sphinx" -optional = true -python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*" -files = [ - {file = "sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl", hash = "sha256:4d35a56f4508cfee4c4fb604373ede6feae2a306731d533f409ef5c3496fdbd8"}, - {file = "sphinx_rtd_theme-1.0.0.tar.gz", hash = "sha256:eec6d497e4c2195fa0e8b2016b337532b8a699a68bcb22a512870e16925c6a5c"}, -] - -[package.dependencies] -docutils = "<0.18" -sphinx = ">=1.6" - -[package.extras] -dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client"] - -[[package]] -name = "sphinxcontrib-applehelp" -version = "2.0.0" -description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books" -optional = true -python-versions = ">=3.9" -files = [ - {file = "sphinxcontrib_applehelp-2.0.0-py3-none-any.whl", hash = "sha256:4cd3f0ec4ac5dd9c17ec65e9ab272c9b867ea77425228e68ecf08d6b28ddbdb5"}, - {file = "sphinxcontrib_applehelp-2.0.0.tar.gz", hash = "sha256:2f29ef331735ce958efa4734873f084941970894c6090408b079c61b2e1c06d1"}, -] - -[package.extras] -lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] -standalone = ["Sphinx (>=5)"] -test = ["pytest"] - -[[package]] -name = "sphinxcontrib-devhelp" -version = "2.0.0" -description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents" -optional = true -python-versions = ">=3.9" -files = [ - {file = "sphinxcontrib_devhelp-2.0.0-py3-none-any.whl", hash = "sha256:aefb8b83854e4b0998877524d1029fd3e6879210422ee3780459e28a1f03a8a2"}, - {file = "sphinxcontrib_devhelp-2.0.0.tar.gz", hash = "sha256:411f5d96d445d1d73bb5d52133377b4248ec79db5c793ce7dbe59e074b4dd1ad"}, -] - -[package.extras] -lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] -standalone = ["Sphinx (>=5)"] -test = ["pytest"] - -[[package]] -name = "sphinxcontrib-htmlhelp" -version = "2.1.0" -description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" -optional = true -python-versions = ">=3.9" -files = [ - {file = "sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl", hash = "sha256:166759820b47002d22914d64a075ce08f4c46818e17cfc9470a9786b759b19f8"}, - {file = "sphinxcontrib_htmlhelp-2.1.0.tar.gz", hash = "sha256:c9e2916ace8aad64cc13a0d233ee22317f2b9025b9cf3295249fa985cc7082e9"}, -] - -[package.extras] -lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] -standalone = ["Sphinx (>=5)"] -test = ["html5lib", "pytest"] - -[[package]] -name = "sphinxcontrib-jsmath" -version = "1.0.1" -description = "A sphinx extension which renders display math in HTML via JavaScript" -optional = true -python-versions = ">=3.5" -files = [ - {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, - {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, -] - -[package.extras] -test = ["flake8", "mypy", "pytest"] - -[[package]] -name = "sphinxcontrib-qthelp" -version = "2.0.0" -description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents" -optional = true -python-versions = ">=3.9" -files = [ - {file = "sphinxcontrib_qthelp-2.0.0-py3-none-any.whl", hash = "sha256:b18a828cdba941ccd6ee8445dbe72ffa3ef8cbe7505d8cd1fa0d42d3f2d5f3eb"}, - {file = "sphinxcontrib_qthelp-2.0.0.tar.gz", hash = "sha256:4fe7d0ac8fc171045be623aba3e2a8f613f8682731f9153bb2e40ece16b9bbab"}, -] - -[package.extras] -lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] -standalone = ["Sphinx (>=5)"] -test = ["defusedxml (>=0.7.1)", "pytest"] - -[[package]] -name = "sphinxcontrib-serializinghtml" -version = "2.0.0" -description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)" -optional = true -python-versions = ">=3.9" -files = [ - {file = "sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl", hash = "sha256:6e2cb0eef194e10c27ec0023bfeb25badbbb5868244cf5bc5bdc04e4464bf331"}, - {file = "sphinxcontrib_serializinghtml-2.0.0.tar.gz", hash = "sha256:e9d912827f872c029017a53f0ef2180b327c3f7fd23c87229f7a8e8b70031d4d"}, -] - -[package.extras] -lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] -standalone = ["Sphinx (>=5)"] -test = ["pytest"] - [[package]] name = "sqlalchemy" version = "2.0.35" @@ -4867,35 +4647,6 @@ files = [ {file = "types_cachetools-5.5.0.20240820-py3-none-any.whl", hash = "sha256:efb2ed8bf27a4b9d3ed70d33849f536362603a90b8090a328acf0cd42fda82e2"}, ] -[[package]] -name = "types-cffi" -version = "1.16.0.20240331" -description = "Typing stubs for cffi" -optional = false -python-versions = ">=3.8" -files = [ - {file = "types-cffi-1.16.0.20240331.tar.gz", hash = "sha256:b8b20d23a2b89cfed5f8c5bc53b0cb8677c3aac6d970dbc771e28b9c698f5dee"}, - {file = "types_cffi-1.16.0.20240331-py3-none-any.whl", hash = "sha256:a363e5ea54a4eb6a4a105d800685fde596bc318089b025b27dee09849fe41ff0"}, -] - -[package.dependencies] -types-setuptools = "*" - -[[package]] -name = "types-pyopenssl" -version = "24.1.0.20240722" -description = "Typing stubs for pyOpenSSL" -optional = false -python-versions = ">=3.8" -files = [ - {file = "types-pyOpenSSL-24.1.0.20240722.tar.gz", hash = "sha256:47913b4678a01d879f503a12044468221ed8576263c1540dcb0484ca21b08c39"}, - {file = "types_pyOpenSSL-24.1.0.20240722-py3-none-any.whl", hash = "sha256:6a7a5d2ec042537934cfb4c9d4deb0e16c4c6250b09358df1f083682fe6fda54"}, -] - -[package.dependencies] -cryptography = ">=35.0.0" -types-cffi = "*" - [[package]] name = "types-python-dateutil" version = "2.9.0.20241003" @@ -4929,21 +4680,6 @@ files = [ {file = "types_PyYAML-6.0.12.20240917-py3-none-any.whl", hash = "sha256:392b267f1c0fe6022952462bf5d6523f31e37f6cea49b14cee7ad634b6301570"}, ] -[[package]] -name = "types-redis" -version = "4.6.0.20241004" -description = "Typing stubs for redis" -optional = false -python-versions = ">=3.8" -files = [ - {file = "types-redis-4.6.0.20241004.tar.gz", hash = "sha256:5f17d2b3f9091ab75384153bfa276619ffa1cf6a38da60e10d5e6749cc5b902e"}, - {file = "types_redis-4.6.0.20241004-py3-none-any.whl", hash = "sha256:ef5da68cb827e5f606c8f9c0b49eeee4c2669d6d97122f301d3a55dc6a63f6ed"}, -] - -[package.dependencies] -cryptography = ">=35.0.0" -types-pyOpenSSL = "*" - [[package]] name = "types-requests" version = "2.32.0.20241016" @@ -4958,28 +4694,6 @@ files = [ [package.dependencies] urllib3 = ">=2" -[[package]] -name = "types-setuptools" -version = "75.6.0.20241126" -description = "Typing stubs for setuptools" -optional = false -python-versions = ">=3.8" -files = [ - {file = "types_setuptools-75.6.0.20241126-py3-none-any.whl", hash = "sha256:aaae310a0e27033c1da8457d4d26ac673b0c8a0de7272d6d4708e263f2ea3b9b"}, - {file = "types_setuptools-75.6.0.20241126.tar.gz", hash = "sha256:7bf25ad4be39740e469f9268b6beddda6e088891fa5a27e985c6ce68bf62ace0"}, -] - -[[package]] -name = "types-ujson" -version = "5.10.0.20240515" -description = "Typing stubs for ujson" -optional = false -python-versions = ">=3.8" -files = [ - {file = "types-ujson-5.10.0.20240515.tar.gz", hash = "sha256:ceae7127f0dafe4af5dd0ecf98ee13e9d75951ef963b5c5a9b7ea92e0d71f0d7"}, - {file = "types_ujson-5.10.0.20240515-py3-none-any.whl", hash = "sha256:02bafc36b3a93d2511757a64ff88bd505e0a57fba08183a9150fbcfcb2015310"}, -] - [[package]] name = "typing-extensions" version = "4.12.2" @@ -5327,11 +5041,10 @@ type = ["pytest-mypy"] [extras] file-based = ["avro", "fastavro", "markdown", "pdf2image", "pdfminer.six", "pyarrow", "pytesseract", "python-calamine", "python-snappy", "unstructured", "unstructured.pytesseract"] -sphinx-docs = ["Sphinx", "sphinx-rtd-theme"] sql = ["sqlalchemy"] vector-db-based = ["cohere", "langchain", "openai", "tiktoken"] [metadata] lock-version = "2.0" python-versions = "^3.10,<3.13" -content-hash = "e0ef863b4ed5381ffe0ae40e03c327394611d3cbde70fc81e027aaa1d1db3f27" +content-hash = "2b774b097cd8c896e59f37d0ca640503b324ab8aebe8f3ba9b5fc2dfd4b63049" diff --git a/pyproject.toml b/pyproject.toml index 9a0e80327..c3267ed70 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,8 +66,6 @@ pyarrow = { version = "~15.0.0", optional = true } pytesseract = { version = "0.3.10", optional = true } python-calamine = { version = "0.2.3", optional = true } python-snappy = { version = "0.7.3", optional = true } -Sphinx = { version = "~4.2", optional = true } -sphinx-rtd-theme = { version = "~1.0", optional = true } tiktoken = { version = "0.8.0", optional = true } nltk = { version = "3.9.1", optional = true } # This will ensure that even when you run poetry install or pip install, the compatible version of numpy will always be chosen. @@ -106,7 +104,6 @@ types-cachetools = "^5.5.0.20240820" [tool.poetry.extras] file-based = ["avro", "fastavro", "pyarrow", "unstructured", "pdf2image", "pdfminer.six", "unstructured.pytesseract", "pytesseract", "markdown", "python-calamine", "python-snappy"] -sphinx-docs = ["Sphinx", "sphinx-rtd-theme"] vector-db-based = ["langchain", "openai", "cohere", "tiktoken"] sql = ["sqlalchemy"] @@ -198,6 +195,6 @@ filterwarnings = [ [tool.airbyte_ci] python_versions = ["3.10", "3.11"] optional_poetry_groups = ["dev"] -poetry_extras = ["file-based", "sphinx-docs", "vector-db-based"] +poetry_extras = ["file-based", "vector-db-based"] poe_tasks = ["check-ci"] mount_docker_socket = true diff --git a/reference_docs/Makefile b/reference_docs/Makefile deleted file mode 100644 index c7f926397..000000000 --- a/reference_docs/Makefile +++ /dev/null @@ -1,23 +0,0 @@ -# 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 diff --git a/reference_docs/_source/api/airbyte_cdk.destinations.rst b/reference_docs/_source/api/airbyte_cdk.destinations.rst deleted file mode 100644 index e554319db..000000000 --- a/reference_docs/_source/api/airbyte_cdk.destinations.rst +++ /dev/null @@ -1,19 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.models.rst b/reference_docs/_source/api/airbyte_cdk.models.rst deleted file mode 100644 index 14d3065dd..000000000 --- a/reference_docs/_source/api/airbyte_cdk.models.rst +++ /dev/null @@ -1,19 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.rst b/reference_docs/_source/api/airbyte_cdk.rst deleted file mode 100644 index 4d270b65e..000000000 --- a/reference_docs/_source/api/airbyte_cdk.rst +++ /dev/null @@ -1,54 +0,0 @@ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk.destinations - airbyte_cdk.models - airbyte_cdk.sources - airbyte_cdk.utils - -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.exception\_handler module --------------------------------------- - -.. automodule:: airbyte_cdk.exception_handler - :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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst deleted file mode 100644 index 43c8a518e..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.auth.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.auth.oauth module --------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.auth.oauth - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.auth.token module --------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.auth.token - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.auth - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst deleted file mode 100644 index d4d275419..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.checks.rst +++ /dev/null @@ -1,27 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst deleted file mode 100644 index f523d1b17..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.datetime.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.datetime.datetime\_parser module ------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.datetime.datetime_parser - :members: - :undoc-members: - :show-inheritance: - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst deleted file mode 100644 index 3d4a362b1..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.decoders.rst +++ /dev/null @@ -1,27 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst deleted file mode 100644 index 3b901d5c9..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.extractors.rst +++ /dev/null @@ -1,51 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.extractors.dpath\_extractor module -------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.extractors.dpath_extractor - :members: - :undoc-members: - :show-inheritance: - -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.record\_extractor module --------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.extractors.record_extractor - :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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst deleted file mode 100644 index 22ab88385..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.interpolation.rst +++ /dev/null @@ -1,59 +0,0 @@ - -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: - -airbyte\_cdk.sources.declarative.interpolation.macros module ------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.interpolation.macros - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.interpolation - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst deleted file mode 100644 index c5f9fdb8b..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.parsers.rst +++ /dev/null @@ -1,59 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.rst deleted file mode 100644 index 0fa4a8c40..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.rst +++ /dev/null @@ -1,51 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.backoff\_strategies.constant\_backoff\_strategy module ------------------------------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.constant_backoff_strategy - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.backoff\_strategies.exponential\_backoff\_strategy module ---------------------------------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.exponential_backoff_strategy - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.backoff\_strategies.header\_helper module ------------------------------------------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.header_helper - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.backoff\_strategies.wait\_time\_from\_header\_backoff\_strategy module ----------------------------------------------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.wait_time_from_header_backoff_strategy - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.backoff\_strategies.wait\_until\_time\_from\_header\_backoff\_strategy module ------------------------------------------------------------------------------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies.wait_until_time_from_header_backoff_strategy - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.rst deleted file mode 100644 index 5b69c8b19..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.error_handlers.rst +++ /dev/null @@ -1,75 +0,0 @@ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategies - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.backoff\_strategy module ------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.backoff_strategy - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.composite\_error\_handler module --------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.composite_error_handler - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.default\_error\_handler module ------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.default_error_handler - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.error\_handler module ---------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.error_handler - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.http\_response\_filter module ------------------------------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.http_response_filter - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.response\_action module ------------------------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.response_action - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.error\_handlers.response\_status module ------------------------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers.response_status - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.error_handlers - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst deleted file mode 100644 index fd91f3f08..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.rst +++ /dev/null @@ -1,43 +0,0 @@ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk.sources.declarative.requesters.paginators.strategies - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.paginators.limit\_paginator module ------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.default_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.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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.strategies.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.strategies.rst deleted file mode 100644 index 86f929120..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.paginators.strategies.rst +++ /dev/null @@ -1,43 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.paginators.strategies.cursor\_pagination\_strategy module ------------------------------------------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.strategies.cursor_pagination_strategy - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.paginators.strategies.offset\_increment module ------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.strategies.offset_increment - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.paginators.strategies.page\_increment module ----------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.strategies.page_increment - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.paginators.strategies.pagination\_strategy module ---------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.strategies.pagination_strategy - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.paginators.strategies - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst deleted file mode 100644 index ebb492b2a..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_headers.rst +++ /dev/null @@ -1,27 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_options.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_options.rst deleted file mode 100644 index ff8eb074f..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.request_options.rst +++ /dev/null @@ -1,35 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.request\_options.interpolated\_request\_input\_provider module ----------------------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.request_options.interpolated_request_input_provider - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.request\_options.interpolated\_request\_options\_provider module ------------------------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.request_options.interpolated_request_options_provider - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.request\_options.request\_options\_provider module ----------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.request_options.request_options_provider - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.request_options - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.retriers.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.retriers.rst deleted file mode 100644 index 65e58aec2..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.retriers.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.retriers.default\_retrier module ----------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.retriers.default_retrier - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.retriers.retrier module -------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.retriers.retrier - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.retriers - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.rst deleted file mode 100644 index 63a9dc689..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.requesters.rst +++ /dev/null @@ -1,45 +0,0 @@ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk.sources.declarative.requesters.error_handlers - airbyte_cdk.sources.declarative.requesters.paginators - airbyte_cdk.sources.declarative.requesters.request_options - -Submodules ----------- - -airbyte\_cdk.sources.declarative.requesters.http\_requester module ------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.http_requester - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.request\_option module ------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.request_option - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.requesters.requester module ------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters.requester - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.requesters - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.retrievers.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.retrievers.rst deleted file mode 100644 index 763c66364..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.retrievers.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.retrievers.retriever module ------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.retrievers.retriever - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.retrievers.simple\_retriever module --------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.retrievers.simple_retriever - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.retrievers - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.rst deleted file mode 100644 index 0ffe29a4a..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.rst +++ /dev/null @@ -1,78 +0,0 @@ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk.sources.declarative.auth - airbyte_cdk.sources.declarative.checks - airbyte_cdk.sources.declarative.datetime - airbyte_cdk.sources.declarative.decoders - airbyte_cdk.sources.declarative.extractors - airbyte_cdk.sources.declarative.interpolation - airbyte_cdk.sources.declarative.parsers - airbyte_cdk.sources.declarative.requesters - airbyte_cdk.sources.declarative.retrievers - airbyte_cdk.sources.declarative.schema - airbyte_cdk.sources.declarative.stream_slicers - airbyte_cdk.sources.declarative.transformations - -Submodules ----------- - -airbyte\_cdk.sources.declarative.create\_partial module -------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.create_partial - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.declarative\_source module ------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.declarative_source - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.declarative\_stream module ------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.declarative_stream - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.exceptions module --------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.exceptions - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.types module ---------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.types - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.yaml\_declarative\_source module ------------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.yaml_declarative_source - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.schema.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.schema.rst deleted file mode 100644 index d0da7b6a7..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.schema.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.schema.json\_schema module ------------------------------------------------------------ - -.. automodule:: airbyte_cdk.sources.declarative.schema.json_schema - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.schema.schema\_loader module -------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.schema.schema_loader - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.schema - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.states.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.states.rst deleted file mode 100644 index f4d331f8d..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.states.rst +++ /dev/null @@ -1,27 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.states.dict\_state module ----------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.states.dict_state - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.states.state module ----------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.states.state - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.states - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.stream_slicers.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.stream_slicers.rst deleted file mode 100644 index ed5f6c179..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.stream_slicers.rst +++ /dev/null @@ -1,59 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.stream\_slicers.cartesian\_product\_stream\_slicer module ------------------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers.cartesian_product_stream_slicer - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.stream\_slicers.datetime\_stream\_slicer module --------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers.datetime_stream_slicer - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.stream\_slicers.list\_stream\_slicer module ----------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers.list_stream_slicer - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.stream\_slicers.single\_slice module ---------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers.single_slice - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.stream\_slicers.stream\_slicer module ----------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers.stream_slicer - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.stream\_slicers.substream\_slicer module -------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers.substream_slicer - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.stream_slicers - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.declarative.transformations.rst b/reference_docs/_source/api/airbyte_cdk.sources.declarative.transformations.rst deleted file mode 100644 index 031b1af23..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.declarative.transformations.rst +++ /dev/null @@ -1,35 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.declarative.transformations.add\_fields module -------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.transformations.add_fields - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.transformations.remove\_fields module ----------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.transformations.remove_fields - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.declarative.transformations.transformation module ----------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.declarative.transformations.transformation - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.declarative.transformations - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst b/reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst deleted file mode 100644 index 3d19a99f0..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.deprecated.rst +++ /dev/null @@ -1,27 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.rst b/reference_docs/_source/api/airbyte_cdk.sources.rst deleted file mode 100644 index 0a25c34ae..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.rst +++ /dev/null @@ -1,47 +0,0 @@ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk.sources.declarative - 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.config module ----------------------------------- - -.. automodule:: airbyte_cdk.sources.config - :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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.singer.rst b/reference_docs/_source/api/airbyte_cdk.sources.singer.rst deleted file mode 100644 index 37af436cb..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.singer.rst +++ /dev/null @@ -1,27 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst b/reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst deleted file mode 100644 index 049da2b74..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.streams.http.auth.rst +++ /dev/null @@ -1,35 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst b/reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst deleted file mode 100644 index b2a7bc7d8..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.streams.http.requests_native_auth.rst +++ /dev/null @@ -1,43 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.streams.http.requests\_native\_auth.abstract\_oauth module -------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.streams.http.requests_native_auth.abstract_oauth - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.streams.http.requests\_native\_auth.abstract\_token module -------------------------------------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.streams.http.requests_native_auth.abstract_token - :members: - :undoc-members: - :show-inheritance: - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst b/reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst deleted file mode 100644 index 920db700a..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.streams.http.rst +++ /dev/null @@ -1,44 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.streams.rst b/reference_docs/_source/api/airbyte_cdk.sources.streams.rst deleted file mode 100644 index e00b5d0f3..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.streams.rst +++ /dev/null @@ -1,27 +0,0 @@ - -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: diff --git a/reference_docs/_source/api/airbyte_cdk.sources.utils.rst b/reference_docs/_source/api/airbyte_cdk.sources.utils.rst deleted file mode 100644 index 8b53a23a7..000000000 --- a/reference_docs/_source/api/airbyte_cdk.sources.utils.rst +++ /dev/null @@ -1,51 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.sources.utils.casing module ----------------------------------------- - -.. automodule:: airbyte_cdk.sources.utils.casing - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.utils.catalog\_helpers module --------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.utils.catalog_helpers - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.utils.schema\_helpers module -------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.utils.schema_helpers - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.utils.schema\_models module ------------------------------------------------- - -.. automodule:: airbyte_cdk.sources.utils.schema_models - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.sources.utils.transform module -------------------------------------------- - -.. automodule:: airbyte_cdk.sources.utils.transform - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.sources.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/airbyte_cdk.utils.rst b/reference_docs/_source/api/airbyte_cdk.utils.rst deleted file mode 100644 index d65a8f8ec..000000000 --- a/reference_docs/_source/api/airbyte_cdk.utils.rst +++ /dev/null @@ -1,35 +0,0 @@ - -Submodules ----------- - -airbyte\_cdk.utils.airbyte\_secrets\_utils module -------------------------------------------------- - -.. automodule:: airbyte_cdk.utils.airbyte_secrets_utils - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.utils.event\_timing module ---------------------------------------- - -.. automodule:: airbyte_cdk.utils.event_timing - :members: - :undoc-members: - :show-inheritance: - -airbyte\_cdk.utils.traced\_exception module -------------------------------------------- - -.. automodule:: airbyte_cdk.utils.traced_exception - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: airbyte_cdk.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/reference_docs/_source/api/modules.rst b/reference_docs/_source/api/modules.rst deleted file mode 100644 index 453898da5..000000000 --- a/reference_docs/_source/api/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -airbyte_cdk -=========== - -.. toctree:: - :maxdepth: 4 - - airbyte_cdk diff --git a/reference_docs/_source/conf.py b/reference_docs/_source/conf.py deleted file mode 100644 index c661adb42..000000000 --- a/reference_docs/_source/conf.py +++ /dev/null @@ -1,66 +0,0 @@ -# -# Copyright (c) 2023 Airbyte, Inc., all rights reserved. -# - -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys - -sys.path.insert(0, os.path.abspath("../..")) - - -# -- Project information ----------------------------------------------------- - -project = "Airbyte Connector Development Kit" -copyright = "2021, Airbyte" -author = "Airbyte" - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.napoleon", # Support for NumPy and Google style docstrings -] # API docs - -source_suffix = {".rst": "restructuredtext", ".md": "markdown"} - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = "sphinx_rtd_theme" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] -html_logo = "../_static/img/airbyte_new_logo.svg" -html_theme_options = { - "logo_only": True, - "display_version": False, -} diff --git a/reference_docs/_source/index.rst b/reference_docs/_source/index.rst deleted file mode 100644 index cc6beef3e..000000000 --- a/reference_docs/_source/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -Welcome to Airbyte Connector Development Kit's documentation! -============================================================= -This documentation is autogenerated from source code comments. More extensive overviews and conceptual explanations will be coming soon. -======================================================================================================================================== - -.. toctree:: - :maxdepth: 4 - :caption: Destinations - - api/airbyte_cdk.destinations - -.. toctree:: - :maxdepth: 4 - :caption: Models - - api/airbyte_cdk.models - -.. toctree:: - :maxdepth: 4 - :caption: Sources - - api/airbyte_cdk.sources - -.. toctree:: - :maxdepth: 4 - :caption: Utils - - api/airbyte_cdk.utils - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/reference_docs/_source/templates/master_doc.rst_t b/reference_docs/_source/templates/master_doc.rst_t deleted file mode 100644 index 082c0ce4e..000000000 --- a/reference_docs/_source/templates/master_doc.rst_t +++ /dev/null @@ -1,19 +0,0 @@ -Welcome to Airbyte Connector Development Kit's documentation! -============================================================= -This documentation is autogenerated from source code comments. More extensive overviews and conceptual explanations will be coming soon. -======================================================================================================================================== -{% for module in top_modules %} -.. toctree:: - :maxdepth: {{ maxdepth }} - :caption: {{ module.caption }} - - {{module.path}} -{% endfor %} - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/reference_docs/_source/templates/package.rst_t b/reference_docs/_source/templates/package.rst_t deleted file mode 100644 index 8c7700310..000000000 --- a/reference_docs/_source/templates/package.rst_t +++ /dev/null @@ -1,51 +0,0 @@ -{%- macro automodule(modname, options) -%} -.. automodule:: {{ modname }} -{%- for option in options %} - :{{ option }}: -{%- endfor %} -{%- endmacro %} - -{%- macro toctree(docnames) -%} -.. toctree:: - :maxdepth: {{ maxdepth }} -{% for docname in docnames %} - {{ docname }} -{%- endfor %} -{%- endmacro %} - -{%- if is_namespace %} -.. py:module:: {{ pkgname }} -{% endif %} - -{%- if modulefirst and not is_namespace %} -{{ automodule(pkgname, automodule_options) }} -{% endif %} - -{%- if subpackages %} -Subpackages ------------ - -{{ toctree(subpackages) }} -{% endif %} - -{%- if submodules %} -Submodules ----------- -{% if separatemodules %} -{{ toctree(submodules) }} -{% else %} -{%- for submodule in submodules %} -{% if show_headings %} -{{- [submodule, "module"] | join(" ") | e | heading(2) }} -{% endif %} -{{ automodule(submodule, automodule_options) }} -{% endfor %} -{%- endif %} -{%- endif %} - -{%- if not modulefirst and not is_namespace %} -Module contents ---------------- - -{{ automodule(pkgname, automodule_options) }} -{% endif %} diff --git a/reference_docs/_static/img/airbyte_new_logo.svg b/reference_docs/_static/img/airbyte_new_logo.svg deleted file mode 100644 index 463f23913..000000000 --- a/reference_docs/_static/img/airbyte_new_logo.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/reference_docs/generate_rst_schema.py b/reference_docs/generate_rst_schema.py deleted file mode 100755 index 1a2268ee0..000000000 --- a/reference_docs/generate_rst_schema.py +++ /dev/null @@ -1,54 +0,0 @@ -# -# Copyright (c) 2023 Airbyte, Inc., all rights reserved. -# - -import sys -from os import path -from typing import Any, Dict - -from sphinx.cmd.quickstart import QuickstartRenderer -from sphinx.ext.apidoc import get_parser, main, recurse_tree, write_file -from sphinx.locale import __ -from sphinx.util import ensuredir - - -def write_master_file(templatedir: str, master_name: str, values: Dict, opts: Any): - template = QuickstartRenderer(templatedir=templatedir) - opts.destdir = opts.destdir[: opts.destdir.rfind("/")] - write_file(master_name, template.render(f"{templatedir}/master_doc.rst_t", values), opts) - - -if __name__ == "__main__": - parser = get_parser() - parser.add_argument( - "--master", metavar="MASTER", default="index", help=__("master document name") - ) - args = parser.parse_args(sys.argv[1:]) - - rootpath = path.abspath(args.module_path) - - # normalize opts - if args.header is None: - args.header = rootpath.split(path.sep)[-1] - if args.suffix.startswith("."): - args.suffix = args.suffix[1:] - if not path.isdir(rootpath): - print(__(f"{rootpath} is not a directory."), file=sys.stderr) - sys.exit(1) - if not args.dryrun: - ensuredir(args.destdir) - excludes = [path.abspath(exclude) for exclude in args.exclude_pattern] - modules = recurse_tree(rootpath, excludes, args, args.templatedir) - - template_values = { - "top_modules": [ - {"path": f"api/{module}", "caption": module.split(".")[1].title()} - for module in modules - if module.count(".") == 1 - ], - "maxdepth": args.maxdepth, - } - write_master_file( - templatedir=args.templatedir, master_name=args.master, values=template_values, opts=args - ) - main() diff --git a/sphinx-docs.md b/sphinx-docs.md deleted file mode 100644 index 4b2e2be3b..000000000 --- a/sphinx-docs.md +++ /dev/null @@ -1,97 +0,0 @@ -# Sphinx Docs - -We're using the [Sphinx](https://www.sphinx-doc.org/) library in order -to automatically generate the docs for the [airbyte-cdk](https://pypi.org/project/airbyte-cdk/). - -## Updating the docs structure (manually) - -Documentation structure is set in `airbyte-cdk/python/reference_docs/_source`, using the `.rst` files. - -See [reStructuredText docs](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) -for the key concepts. - -Note that `index.rst` is the main index file, where we do define the layout of the main -docs page and relation to other sections. - -Each time a new module added to `airbyte-cdk/python/airbyte_cdk` module you'll need to update the Sphinx rst schema. - -Let's dive into using an example: - -- Assuming we're going to add a new package `airbyte_cdk/new_package`; -- Let this file contain a few modules: `airbyte_cdk/new_package/module1.py` and `airbyte_cdk/new_package/module2.py`; -- The above structure should be in `rst` config as: - - - Add this block directly into `index.rst`: - - ``` - .. toctree:: - :maxdepth: 2 - :caption: New Package - - api/airbyte_cdk.new_package - ``` - - - Add a new file `api/airbyte_cdk.new_package.rst` with the following content: - - ``` - Submodules - ---------- - - airbyte\_cdk.new\_package.module1 module - -------------------------------------------- - - .. automodule:: airbyte_cdk.new_package.module1 - :members: - :undoc-members: - :show-inheritance: - - .. automodule:: airbyte_cdk.new_package.module2 - :members: - :undoc-members: - :show-inheritance: - - Module contents - --------------- - - .. automodule:: airbyte_cdk.models - :members: - :undoc-members: - :show-inheritance: - ``` - -For more examples see `airbyte-cdk/python/reference_docs/_source` -and read the [docs](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html). - -## Updating the docs structure (automatically) - -It's also possible to generate `.rst` files automatically using `generate_rst_schema.py` script. - -You should also update this script in order to change the docs appearance or structure. - -To generate the docs, -run `python generate_rst_schema.py -o _source/api ../../python/airbyte_cdk -f -t _source/templates` -from the `airbyte-cdk/python/reference_docs` root. - -## Building the docs locally - -After the `rst` files created to correctly represent current project structure you may build the docs locally. -This build could be useful on each `airbyte-cdk` update, especially if the package structure was changed. - -- Install Sphinx deps with `pip install ".[sphinx-docs]"`; -- Run `make html` from the `airbyte-cdk/python/reference_docs` root; -- Check out the `airbyte-cdk/python/reference_docs/_build` for the new documentation built. - -## Publishing to Read the Docs - -Our current sphinx docs setup is meant to be published to [readthedocs](https://readthedocs.org/). -So it may be useful to check our docs published at https://airbyte-cdk.readthedocs.io/en/latest/ -for the last build in case if the airbyte-cdk package was updated. - -Publishing process is automatic and implemented via the GitHub incoming webhook. -See https://docs.readthedocs.io/en/stable/webhooks.html. - -To check build logs and state, check the https://readthedocs.org/projects/airbyte-cdk/builds/. -You may also run build manually here if needed. - -Publishing configuration is placed to `.readthedocs.yaml`. -See https://docs.readthedocs.io/en/stable/config-file/v2.html for the config description.