diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml new file mode 100644 index 0000000..82a6012 --- /dev/null +++ b/.github/workflows/publish_docs.yml @@ -0,0 +1,36 @@ +name: Publish Docs to Github Pages + +on: + release: + types: [published] + +jobs: + docs: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install Dependencies + run: | + pip install --upgrade pip + pip install .[dev] + + - name: Build Sphinx Documentation + run: | + cd docs + make html + + - name: Deploy to Github Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/_build/html + keep_files: false + + diff --git a/.gitignore b/.gitignore index 96c3fe2..76051c7 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,8 @@ .ruff_cache +**/_build/ + venv/ .venv/ @@ -22,3 +24,4 @@ env/ \#*\# .\#* .projectile + diff --git a/Makefile b/Makefile index 0327892..bafa3ab 100644 --- a/Makefile +++ b/Makefile @@ -25,3 +25,7 @@ repl: .PHONY: install-deps install-deps: pip install .[dev] + +.PHONY: docs +docs: + sphinx-apidoc -o docs/ ./cdp/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/cdp.client.api.rst b/docs/cdp.client.api.rst new file mode 100644 index 0000000..7d27fa5 --- /dev/null +++ b/docs/cdp.client.api.rst @@ -0,0 +1,149 @@ +cdp.client.api package +====================== + +Submodules +---------- + +cdp.client.api.addresses\_api module +------------------------------------ + +.. automodule:: cdp.client.api.addresses_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.assets\_api module +--------------------------------- + +.. automodule:: cdp.client.api.assets_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.balance\_history\_api module +------------------------------------------- + +.. automodule:: cdp.client.api.balance_history_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.contract\_events\_api module +------------------------------------------- + +.. automodule:: cdp.client.api.contract_events_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.contract\_invocations\_api module +------------------------------------------------ + +.. automodule:: cdp.client.api.contract_invocations_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.external\_addresses\_api module +---------------------------------------------- + +.. automodule:: cdp.client.api.external_addresses_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.networks\_api module +----------------------------------- + +.. automodule:: cdp.client.api.networks_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.server\_signers\_api module +------------------------------------------ + +.. automodule:: cdp.client.api.server_signers_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.smart\_contracts\_api module +------------------------------------------- + +.. automodule:: cdp.client.api.smart_contracts_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.stake\_api module +-------------------------------- + +.. automodule:: cdp.client.api.stake_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.trades\_api module +--------------------------------- + +.. automodule:: cdp.client.api.trades_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.transfers\_api module +------------------------------------ + +.. automodule:: cdp.client.api.transfers_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.users\_api module +-------------------------------- + +.. automodule:: cdp.client.api.users_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.validators\_api module +------------------------------------- + +.. automodule:: cdp.client.api.validators_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.wallet\_stake\_api module +---------------------------------------- + +.. automodule:: cdp.client.api.wallet_stake_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.wallets\_api module +---------------------------------- + +.. automodule:: cdp.client.api.wallets_api + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api.webhooks\_api module +----------------------------------- + +.. automodule:: cdp.client.api.webhooks_api + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cdp.client.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/cdp.client.models.rst b/docs/cdp.client.models.rst new file mode 100644 index 0000000..4ff0b6f --- /dev/null +++ b/docs/cdp.client.models.rst @@ -0,0 +1,757 @@ +cdp.client.models package +========================= + +Submodules +---------- + +cdp.client.models.address module +-------------------------------- + +.. automodule:: cdp.client.models.address + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.address\_balance\_list module +----------------------------------------------- + +.. automodule:: cdp.client.models.address_balance_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.address\_historical\_balance\_list module +----------------------------------------------------------- + +.. automodule:: cdp.client.models.address_historical_balance_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.address\_list module +-------------------------------------- + +.. automodule:: cdp.client.models.address_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.address\_transaction\_list module +--------------------------------------------------- + +.. automodule:: cdp.client.models.address_transaction_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.asset module +------------------------------ + +.. automodule:: cdp.client.models.asset + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.balance module +-------------------------------- + +.. automodule:: cdp.client.models.balance + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.broadcast\_contract\_invocation\_request module +----------------------------------------------------------------- + +.. automodule:: cdp.client.models.broadcast_contract_invocation_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.broadcast\_staking\_operation\_request module +--------------------------------------------------------------- + +.. automodule:: cdp.client.models.broadcast_staking_operation_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.broadcast\_trade\_request module +-------------------------------------------------- + +.. automodule:: cdp.client.models.broadcast_trade_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.broadcast\_transfer\_request module +----------------------------------------------------- + +.. automodule:: cdp.client.models.broadcast_transfer_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.build\_staking\_operation\_request module +----------------------------------------------------------- + +.. automodule:: cdp.client.models.build_staking_operation_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.contract\_event module +---------------------------------------- + +.. automodule:: cdp.client.models.contract_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.contract\_event\_list module +---------------------------------------------- + +.. automodule:: cdp.client.models.contract_event_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.contract\_invocation module +--------------------------------------------- + +.. automodule:: cdp.client.models.contract_invocation + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.contract\_invocation\_list module +--------------------------------------------------- + +.. automodule:: cdp.client.models.contract_invocation_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_address\_request module +------------------------------------------------- + +.. automodule:: cdp.client.models.create_address_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_contract\_invocation\_request module +-------------------------------------------------------------- + +.. automodule:: cdp.client.models.create_contract_invocation_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_payload\_signature\_request module +------------------------------------------------------------ + +.. automodule:: cdp.client.models.create_payload_signature_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_server\_signer\_request module +-------------------------------------------------------- + +.. automodule:: cdp.client.models.create_server_signer_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_smart\_contract\_request module +--------------------------------------------------------- + +.. automodule:: cdp.client.models.create_smart_contract_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_staking\_operation\_request module +------------------------------------------------------------ + +.. automodule:: cdp.client.models.create_staking_operation_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_trade\_request module +----------------------------------------------- + +.. automodule:: cdp.client.models.create_trade_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_transfer\_request module +-------------------------------------------------- + +.. automodule:: cdp.client.models.create_transfer_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_wallet\_request module +------------------------------------------------ + +.. automodule:: cdp.client.models.create_wallet_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_wallet\_request\_wallet module +-------------------------------------------------------- + +.. automodule:: cdp.client.models.create_wallet_request_wallet + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.create\_webhook\_request module +------------------------------------------------- + +.. automodule:: cdp.client.models.create_webhook_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.deploy\_smart\_contract\_request module +--------------------------------------------------------- + +.. automodule:: cdp.client.models.deploy_smart_contract_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.erc20\_transfer\_event module +----------------------------------------------- + +.. automodule:: cdp.client.models.erc20_transfer_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.erc721\_transfer\_event module +------------------------------------------------ + +.. automodule:: cdp.client.models.erc721_transfer_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.error module +------------------------------ + +.. automodule:: cdp.client.models.error + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.ethereum\_transaction module +---------------------------------------------- + +.. automodule:: cdp.client.models.ethereum_transaction + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.ethereum\_transaction\_access module +------------------------------------------------------ + +.. automodule:: cdp.client.models.ethereum_transaction_access + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.ethereum\_transaction\_access\_list module +------------------------------------------------------------ + +.. automodule:: cdp.client.models.ethereum_transaction_access_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.ethereum\_transaction\_flattened\_trace module +---------------------------------------------------------------- + +.. automodule:: cdp.client.models.ethereum_transaction_flattened_trace + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.ethereum\_validator\_metadata module +------------------------------------------------------ + +.. automodule:: cdp.client.models.ethereum_validator_metadata + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.faucet\_transaction module +-------------------------------------------- + +.. automodule:: cdp.client.models.faucet_transaction + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.feature\_set module +------------------------------------- + +.. automodule:: cdp.client.models.feature_set + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.fetch\_historical\_staking\_balances200\_response module +-------------------------------------------------------------------------- + +.. automodule:: cdp.client.models.fetch_historical_staking_balances200_response + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.fetch\_staking\_rewards200\_response module +------------------------------------------------------------- + +.. automodule:: cdp.client.models.fetch_staking_rewards200_response + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.fetch\_staking\_rewards\_request module +--------------------------------------------------------- + +.. automodule:: cdp.client.models.fetch_staking_rewards_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.get\_staking\_context\_request module +------------------------------------------------------- + +.. automodule:: cdp.client.models.get_staking_context_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.historical\_balance module +-------------------------------------------- + +.. automodule:: cdp.client.models.historical_balance + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.network module +-------------------------------- + +.. automodule:: cdp.client.models.network + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.network\_identifier module +-------------------------------------------- + +.. automodule:: cdp.client.models.network_identifier + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.nft\_contract\_options module +----------------------------------------------- + +.. automodule:: cdp.client.models.nft_contract_options + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.payload\_signature module +------------------------------------------- + +.. automodule:: cdp.client.models.payload_signature + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.payload\_signature\_list module +------------------------------------------------- + +.. automodule:: cdp.client.models.payload_signature_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.seed\_creation\_event module +---------------------------------------------- + +.. automodule:: cdp.client.models.seed_creation_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.seed\_creation\_event\_result module +------------------------------------------------------ + +.. automodule:: cdp.client.models.seed_creation_event_result + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.server\_signer module +--------------------------------------- + +.. automodule:: cdp.client.models.server_signer + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.server\_signer\_event module +---------------------------------------------- + +.. automodule:: cdp.client.models.server_signer_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.server\_signer\_event\_event module +----------------------------------------------------- + +.. automodule:: cdp.client.models.server_signer_event_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.server\_signer\_event\_list module +---------------------------------------------------- + +.. automodule:: cdp.client.models.server_signer_event_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.server\_signer\_list module +--------------------------------------------- + +.. automodule:: cdp.client.models.server_signer_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.signature\_creation\_event module +--------------------------------------------------- + +.. automodule:: cdp.client.models.signature_creation_event + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.signature\_creation\_event\_result module +----------------------------------------------------------- + +.. automodule:: cdp.client.models.signature_creation_event_result + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.signed\_voluntary\_exit\_message\_metadata module +------------------------------------------------------------------- + +.. automodule:: cdp.client.models.signed_voluntary_exit_message_metadata + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.smart\_contract module +---------------------------------------- + +.. automodule:: cdp.client.models.smart_contract + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.smart\_contract\_list module +---------------------------------------------- + +.. automodule:: cdp.client.models.smart_contract_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.smart\_contract\_options module +------------------------------------------------- + +.. automodule:: cdp.client.models.smart_contract_options + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.smart\_contract\_type module +---------------------------------------------- + +.. automodule:: cdp.client.models.smart_contract_type + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.sponsored\_send module +---------------------------------------- + +.. automodule:: cdp.client.models.sponsored_send + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_balance module +----------------------------------------- + +.. automodule:: cdp.client.models.staking_balance + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_context module +----------------------------------------- + +.. automodule:: cdp.client.models.staking_context + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_context\_context module +-------------------------------------------------- + +.. automodule:: cdp.client.models.staking_context_context + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_operation module +------------------------------------------- + +.. automodule:: cdp.client.models.staking_operation + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_operation\_metadata module +----------------------------------------------------- + +.. automodule:: cdp.client.models.staking_operation_metadata + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_reward module +---------------------------------------- + +.. automodule:: cdp.client.models.staking_reward + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_reward\_format module +------------------------------------------------ + +.. automodule:: cdp.client.models.staking_reward_format + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.staking\_reward\_usd\_value module +---------------------------------------------------- + +.. automodule:: cdp.client.models.staking_reward_usd_value + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.token\_contract\_options module +------------------------------------------------- + +.. automodule:: cdp.client.models.token_contract_options + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.trade module +------------------------------ + +.. automodule:: cdp.client.models.trade + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.trade\_list module +------------------------------------ + +.. automodule:: cdp.client.models.trade_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.transaction module +------------------------------------ + +.. automodule:: cdp.client.models.transaction + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.transaction\_content module +--------------------------------------------- + +.. automodule:: cdp.client.models.transaction_content + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.transaction\_type module +------------------------------------------ + +.. automodule:: cdp.client.models.transaction_type + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.transfer module +--------------------------------- + +.. automodule:: cdp.client.models.transfer + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.transfer\_list module +--------------------------------------- + +.. automodule:: cdp.client.models.transfer_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.update\_webhook\_request module +------------------------------------------------- + +.. automodule:: cdp.client.models.update_webhook_request + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.user module +----------------------------- + +.. automodule:: cdp.client.models.user + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.validator module +---------------------------------- + +.. automodule:: cdp.client.models.validator + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.validator\_details module +------------------------------------------- + +.. automodule:: cdp.client.models.validator_details + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.validator\_list module +---------------------------------------- + +.. automodule:: cdp.client.models.validator_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.validator\_status module +------------------------------------------ + +.. automodule:: cdp.client.models.validator_status + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.wallet module +------------------------------- + +.. automodule:: cdp.client.models.wallet + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.wallet\_list module +------------------------------------- + +.. automodule:: cdp.client.models.wallet_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.webhook module +-------------------------------- + +.. automodule:: cdp.client.models.webhook + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.webhook\_event\_filter module +----------------------------------------------- + +.. automodule:: cdp.client.models.webhook_event_filter + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.webhook\_event\_type module +--------------------------------------------- + +.. automodule:: cdp.client.models.webhook_event_type + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.webhook\_event\_type\_filter module +----------------------------------------------------- + +.. automodule:: cdp.client.models.webhook_event_type_filter + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.webhook\_list module +-------------------------------------- + +.. automodule:: cdp.client.models.webhook_list + :members: + :undoc-members: + :show-inheritance: + +cdp.client.models.webhook\_wallet\_activity\_filter module +---------------------------------------------------------- + +.. automodule:: cdp.client.models.webhook_wallet_activity_filter + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cdp.client.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/cdp.client.rst b/docs/cdp.client.rst new file mode 100644 index 0000000..ee539f3 --- /dev/null +++ b/docs/cdp.client.rst @@ -0,0 +1,62 @@ +cdp.client package +================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cdp.client.api + cdp.client.models + +Submodules +---------- + +cdp.client.api\_client module +----------------------------- + +.. automodule:: cdp.client.api_client + :members: + :undoc-members: + :show-inheritance: + +cdp.client.api\_response module +------------------------------- + +.. automodule:: cdp.client.api_response + :members: + :undoc-members: + :show-inheritance: + +cdp.client.configuration module +------------------------------- + +.. automodule:: cdp.client.configuration + :members: + :undoc-members: + :show-inheritance: + +cdp.client.exceptions module +---------------------------- + +.. automodule:: cdp.client.exceptions + :members: + :undoc-members: + :show-inheritance: + +cdp.client.rest module +---------------------- + +.. automodule:: cdp.client.rest + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cdp.client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/cdp.rst b/docs/cdp.rst new file mode 100644 index 0000000..9812bca --- /dev/null +++ b/docs/cdp.rst @@ -0,0 +1,141 @@ +cdp package +=========== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + cdp.client + +Submodules +---------- + +cdp.address module +------------------ + +.. automodule:: cdp.address + :members: + :undoc-members: + :show-inheritance: + +cdp.api\_clients module +----------------------- + +.. automodule:: cdp.api_clients + :members: + :undoc-members: + :show-inheritance: + +cdp.asset module +---------------- + +.. automodule:: cdp.asset + :members: + :undoc-members: + :show-inheritance: + +cdp.balance module +------------------ + +.. automodule:: cdp.balance + :members: + :undoc-members: + :show-inheritance: + +cdp.balance\_map module +----------------------- + +.. automodule:: cdp.balance_map + :members: + :undoc-members: + :show-inheritance: + +cdp.cdp module +-------------- + +.. automodule:: cdp.cdp + :members: + :undoc-members: + :show-inheritance: + +cdp.cdp\_api\_client module +--------------------------- + +.. automodule:: cdp.cdp_api_client + :members: + :undoc-members: + :show-inheritance: + +cdp.errors module +----------------- + +.. automodule:: cdp.errors + :members: + :undoc-members: + :show-inheritance: + +cdp.faucet\_transaction module +------------------------------ + +.. automodule:: cdp.faucet_transaction + :members: + :undoc-members: + :show-inheritance: + +cdp.sponsored\_send module +-------------------------- + +.. automodule:: cdp.sponsored_send + :members: + :undoc-members: + :show-inheritance: + +cdp.trade module +---------------- + +.. automodule:: cdp.trade + :members: + :undoc-members: + :show-inheritance: + +cdp.transaction module +---------------------- + +.. automodule:: cdp.transaction + :members: + :undoc-members: + :show-inheritance: + +cdp.transfer module +------------------- + +.. automodule:: cdp.transfer + :members: + :undoc-members: + :show-inheritance: + +cdp.wallet module +----------------- + +.. automodule:: cdp.wallet + :members: + :undoc-members: + :show-inheritance: + +cdp.wallet\_address module +-------------------------- + +.. automodule:: cdp.wallet_address + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: cdp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..226a6d8 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,37 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +import sys +import os + +sys.path.insert(0, os.path.abspath("..")) + + +project = 'CDP SDK' +author = 'Coinbase Developer Platform' +release = '0.0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'myst_parser', # Parsing Markdown + 'sphinx.ext.autodoc', # Automatically generate documentation from docstrings + 'sphinx.ext.napoleon', # Google-style docstring support + 'sphinx_autodoc_typehints' # Type hints in function signatures +] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..270c1fa --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +CDP SDK documentation +===================== + +.. include:: README.md + :parser: myst_parser.sphinx_ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :hidden: + + modules + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..f261fca --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +cdp +=== + +.. toctree:: + :maxdepth: 4 + + cdp diff --git a/pyproject.toml b/pyproject.toml index 81765bd..b4bcc54 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -103,7 +103,7 @@ Homepage = "https://docs.cdp.coinbase.com/cdp-sdk/docs/welcome" [tool.setuptools.packages.find] where = ["."] include = ["cdp*"] -exclude = ["tests*"] +exclude = ["tests*", "docs*"] [tool.pytest.ini_options] minversion = "6.0" @@ -120,7 +120,7 @@ ignore_missing_imports = true [tool.ruff] line-length = 100 target-version = "py310" -exclude = ["./cdp/client/**", "./build/**", "./dist/**"] +exclude = ["./cdp/client/**", "./build/**", "./dist/**", "./docs/**"] [tool.ruff.lint] select = ["E", "F", "I", "N", "W", "D", "UP", "B", "C4", "SIM", "RUF"]