diff --git a/README.md b/README.md index 552ff158..c1b24433 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,14 @@ If you want to skip network interaction tests run: ``` pytest -m "not networkInteraction" ``` + +### Regenerating the docs + +Each time a new module/submodule is added it needs to be added to the docs, as well. To do `cd` in the root directory then run the following command: +```bash +sphinx-apidoc -f -o docs/ multiversx_sdk/ *_test.py *constants.py +``` + +This command will regenerate the `.rst` files for each module, excluding the tests. + +Also, each time a new version is released, the [**conf.py**](/docs/conf.py) file should be updated accordingly. diff --git a/docs/conf.py b/docs/conf.py index 9d259e1e..12e12646 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,7 @@ extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"] templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '*_test.py', 'constants.py'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # -- Options for HTML output ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index c3ad4aa3..f6751aa3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. multiversx-sdk documentation master file, created by - sphinx-quickstart on Tue Apr 2 16:32:28 2024. + sphinx-quickstart on Wed Apr 3 14:19:32 2024. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/docs/multiversx_sdk.core.proto.rst b/docs/multiversx_sdk.core.proto.rst index 617e2e70..6544a8a1 100644 --- a/docs/multiversx_sdk.core.proto.rst +++ b/docs/multiversx_sdk.core.proto.rst @@ -20,14 +20,6 @@ multiversx\_sdk.core.proto.transaction\_serializer module :undoc-members: :show-inheritance: -multiversx\_sdk.core.proto.transaction\_serializer\_test module ---------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.proto.transaction_serializer_test - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/multiversx_sdk.core.rst b/docs/multiversx_sdk.core.rst index 0ba1b570..6fa2f124 100644 --- a/docs/multiversx_sdk.core.rst +++ b/docs/multiversx_sdk.core.rst @@ -25,14 +25,6 @@ multiversx\_sdk.core.account module :undoc-members: :show-inheritance: -multiversx\_sdk.core.account\_test module ------------------------------------------ - -.. automodule:: multiversx_sdk.core.account_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.address module ----------------------------------- @@ -41,14 +33,6 @@ multiversx\_sdk.core.address module :undoc-members: :show-inheritance: -multiversx\_sdk.core.address\_test module ------------------------------------------ - -.. automodule:: multiversx_sdk.core.address_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.bech32 module ---------------------------------- @@ -65,14 +49,6 @@ multiversx\_sdk.core.code\_metadata module :undoc-members: :show-inheritance: -multiversx\_sdk.core.code\_metadata\_test module ------------------------------------------------- - -.. automodule:: multiversx_sdk.core.code_metadata_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.codec module --------------------------------- @@ -81,22 +57,6 @@ multiversx\_sdk.core.codec module :undoc-members: :show-inheritance: -multiversx\_sdk.core.codec\_test module ---------------------------------------- - -.. automodule:: multiversx_sdk.core.codec_test - :members: - :undoc-members: - :show-inheritance: - -multiversx\_sdk.core.constants module -------------------------------------- - -.. automodule:: multiversx_sdk.core.constants - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.contract\_query module ------------------------------------------- @@ -113,14 +73,6 @@ multiversx\_sdk.core.contract\_query\_builder module :undoc-members: :show-inheritance: -multiversx\_sdk.core.contract\_query\_builder\_test module ----------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.contract_query_builder_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.errors module ---------------------------------- @@ -145,14 +97,6 @@ multiversx\_sdk.core.message module :undoc-members: :show-inheritance: -multiversx\_sdk.core.message\_test module ------------------------------------------ - -.. automodule:: multiversx_sdk.core.message_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.serializer module -------------------------------------- @@ -169,14 +113,6 @@ multiversx\_sdk.core.smart\_contract\_queries\_controller module :undoc-members: :show-inheritance: -multiversx\_sdk.core.smart\_contract\_queries\_controller\_test module ----------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.smart_contract_queries_controller_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.smart\_contract\_query module -------------------------------------------------- @@ -193,14 +129,6 @@ multiversx\_sdk.core.token\_payment module :undoc-members: :show-inheritance: -multiversx\_sdk.core.token\_payment\_test module ------------------------------------------------- - -.. automodule:: multiversx_sdk.core.token_payment_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.tokens module ---------------------------------- @@ -209,14 +137,6 @@ multiversx\_sdk.core.tokens module :undoc-members: :show-inheritance: -multiversx\_sdk.core.tokens\_test module ----------------------------------------- - -.. automodule:: multiversx_sdk.core.tokens_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction module --------------------------------------- @@ -233,14 +153,6 @@ multiversx\_sdk.core.transaction\_payload module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_test module ---------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.typecheck module ------------------------------------- diff --git a/docs/multiversx_sdk.core.transaction_builders.rst b/docs/multiversx_sdk.core.transaction_builders.rst index c12c9962..023b1182 100644 --- a/docs/multiversx_sdk.core.transaction_builders.rst +++ b/docs/multiversx_sdk.core.transaction_builders.rst @@ -12,14 +12,6 @@ multiversx\_sdk.core.transaction\_builders.contract\_builders module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_builders.contract\_builders\_test module --------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_builders.contract_builders_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction\_builders.default\_configuration module ------------------------------------------------------------------------ @@ -28,14 +20,6 @@ multiversx\_sdk.core.transaction\_builders.default\_configuration module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_builders.default\_configuration\_test module ------------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_builders.default_configuration_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction\_builders.esdt\_builders module ---------------------------------------------------------------- @@ -44,14 +28,6 @@ multiversx\_sdk.core.transaction\_builders.esdt\_builders module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_builders.esdt\_builders\_test module ----------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_builders.esdt_builders_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction\_builders.other\_builders module ----------------------------------------------------------------- @@ -68,14 +44,6 @@ multiversx\_sdk.core.transaction\_builders.relayed\_v1\_builder module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_builders.relayed\_v1\_builder\_test module ----------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_builders.relayed_v1_builder_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction\_builders.relayed\_v2\_builder module ---------------------------------------------------------------------- @@ -84,14 +52,6 @@ multiversx\_sdk.core.transaction\_builders.relayed\_v2\_builder module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_builders.relayed\_v2\_builder\_test module ----------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_builders.relayed_v2_builder_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction\_builders.transaction\_builder module ---------------------------------------------------------------------- @@ -108,14 +68,6 @@ multiversx\_sdk.core.transaction\_builders.transfers\_builders module :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_builders.transfers\_builders\_test module ---------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transaction_builders.transfers_builders_test - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/multiversx_sdk.core.transaction_parsers.rst b/docs/multiversx_sdk.core.transaction_parsers.rst index 990e8614..7d627f5f 100644 --- a/docs/multiversx_sdk.core.transaction_parsers.rst +++ b/docs/multiversx_sdk.core.transaction_parsers.rst @@ -20,14 +20,6 @@ multiversx\_sdk.core.transaction\_parsers.token\_operations\_outcome\_parser mod :undoc-members: :show-inheritance: -multiversx\_sdk.core.transaction\_parsers.token\_operations\_outcome\_parser\_test module ------------------------------------------------------------------------------------------ - -.. automodule:: multiversx_sdk.core.transaction_parsers.token_operations_outcome_parser_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transaction\_parsers.token\_operations\_outcome\_parser\_types module ------------------------------------------------------------------------------------------ diff --git a/docs/multiversx_sdk.core.transactions_factories.rst b/docs/multiversx_sdk.core.transactions_factories.rst index 77d64aae..6d5b3ec8 100644 --- a/docs/multiversx_sdk.core.transactions_factories.rst +++ b/docs/multiversx_sdk.core.transactions_factories.rst @@ -12,14 +12,6 @@ multiversx\_sdk.core.transactions\_factories.account\_transactions\_factory modu :undoc-members: :show-inheritance: -multiversx\_sdk.core.transactions\_factories.account\_transactions\_factory\_test module ----------------------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transactions_factories.account_transactions_factory_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transactions\_factories.delegation\_transactions\_factory module ------------------------------------------------------------------------------------- @@ -28,14 +20,6 @@ multiversx\_sdk.core.transactions\_factories.delegation\_transactions\_factory m :undoc-members: :show-inheritance: -multiversx\_sdk.core.transactions\_factories.delegation\_transactions\_factory\_test module -------------------------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transactions_factories.delegation_transactions_factory_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transactions\_factories.relayed\_transactions\_factory module ---------------------------------------------------------------------------------- @@ -44,22 +28,6 @@ multiversx\_sdk.core.transactions\_factories.relayed\_transactions\_factory modu :undoc-members: :show-inheritance: -multiversx\_sdk.core.transactions\_factories.relayed\_transactions\_factory\_test module ----------------------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transactions_factories.relayed_transactions_factory_test - :members: - :undoc-members: - :show-inheritance: - -multiversx\_sdk.core.transactions\_factories.smart\_contract\_transaction\_factory\_test module ------------------------------------------------------------------------------------------------ - -.. automodule:: multiversx_sdk.core.transactions_factories.smart_contract_transaction_factory_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transactions\_factories.smart\_contract\_transactions\_factory module ------------------------------------------------------------------------------------------ @@ -76,14 +44,6 @@ multiversx\_sdk.core.transactions\_factories.token\_management\_transactions\_fa :undoc-members: :show-inheritance: -multiversx\_sdk.core.transactions\_factories.token\_management\_transactions\_factory\_test module --------------------------------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.core.transactions_factories.token_management_transactions_factory_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transactions\_factories.token\_transfers\_data\_builder module ----------------------------------------------------------------------------------- @@ -116,14 +76,6 @@ multiversx\_sdk.core.transactions\_factories.transfer\_transactions\_factory mod :undoc-members: :show-inheritance: -multiversx\_sdk.core.transactions\_factories.transfer\_transactions\_factory\_test module ------------------------------------------------------------------------------------------ - -.. automodule:: multiversx_sdk.core.transactions_factories.transfer_transactions_factory_test - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/multiversx_sdk.core.transactions_outcome_parsers.rst b/docs/multiversx_sdk.core.transactions_outcome_parsers.rst index fafaf713..397b957f 100644 --- a/docs/multiversx_sdk.core.transactions_outcome_parsers.rst +++ b/docs/multiversx_sdk.core.transactions_outcome_parsers.rst @@ -20,14 +20,6 @@ multiversx\_sdk.core.transactions\_outcome\_parsers.token\_management\_transacti :undoc-members: :show-inheritance: -multiversx\_sdk.core.transactions\_outcome\_parsers.token\_management\_transactions\_outcome\_parser\_test module ------------------------------------------------------------------------------------------------------------------ - -.. automodule:: multiversx_sdk.core.transactions_outcome_parsers.token_management_transactions_outcome_parser_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.core.transactions\_outcome\_parsers.token\_management\_transactions\_outcome\_parser\_types module ------------------------------------------------------------------------------------------------------------------ diff --git a/docs/multiversx_sdk.network_providers.rst b/docs/multiversx_sdk.network_providers.rst index fe282244..3ecbf285 100644 --- a/docs/multiversx_sdk.network_providers.rst +++ b/docs/multiversx_sdk.network_providers.rst @@ -20,14 +20,6 @@ multiversx\_sdk.network\_providers.api\_network\_provider module :undoc-members: :show-inheritance: -multiversx\_sdk.network\_providers.api\_network\_provider\_test module ----------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.network_providers.api_network_provider_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.network\_providers.config module ------------------------------------------------ @@ -36,14 +28,6 @@ multiversx\_sdk.network\_providers.config module :undoc-members: :show-inheritance: -multiversx\_sdk.network\_providers.constants module ---------------------------------------------------- - -.. automodule:: multiversx_sdk.network_providers.constants - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.network\_providers.contract\_query\_requests module ------------------------------------------------------------------- @@ -124,14 +108,6 @@ multiversx\_sdk.network\_providers.proxy\_network\_provider module :undoc-members: :show-inheritance: -multiversx\_sdk.network\_providers.proxy\_network\_provider\_test module ------------------------------------------------------------------------- - -.. automodule:: multiversx_sdk.network_providers.proxy_network_provider_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.network\_providers.resources module --------------------------------------------------- diff --git a/docs/multiversx_sdk.wallet.crypto.rst b/docs/multiversx_sdk.wallet.crypto.rst index 1fe091f4..2b5f54e7 100644 --- a/docs/multiversx_sdk.wallet.crypto.rst +++ b/docs/multiversx_sdk.wallet.crypto.rst @@ -4,14 +4,6 @@ multiversx\_sdk.wallet.crypto package Submodules ---------- -multiversx\_sdk.wallet.crypto.constants module ----------------------------------------------- - -.. automodule:: multiversx_sdk.wallet.crypto.constants - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.crypto.decryptor module ---------------------------------------------- diff --git a/docs/multiversx_sdk.wallet.libraries.rst b/docs/multiversx_sdk.wallet.libraries.rst index 3f092179..fcdcee72 100644 --- a/docs/multiversx_sdk.wallet.libraries.rst +++ b/docs/multiversx_sdk.wallet.libraries.rst @@ -12,14 +12,6 @@ multiversx\_sdk.wallet.libraries.bls\_facade module :undoc-members: :show-inheritance: -multiversx\_sdk.wallet.libraries.bls\_facade\_test module ---------------------------------------------------------- - -.. automodule:: multiversx_sdk.wallet.libraries.bls_facade_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.libraries.libbls module ---------------------------------------------- diff --git a/docs/multiversx_sdk.wallet.rst b/docs/multiversx_sdk.wallet.rst index 493355c7..81034b10 100644 --- a/docs/multiversx_sdk.wallet.rst +++ b/docs/multiversx_sdk.wallet.rst @@ -13,14 +13,6 @@ Subpackages Submodules ---------- -multiversx\_sdk.wallet.constants module ---------------------------------------- - -.. automodule:: multiversx_sdk.wallet.constants - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.core module ---------------------------------- @@ -53,14 +45,6 @@ multiversx\_sdk.wallet.mnemonic module :undoc-members: :show-inheritance: -multiversx\_sdk.wallet.mnemonic\_test module --------------------------------------------- - -.. automodule:: multiversx_sdk.wallet.mnemonic_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.pem\_entry module ---------------------------------------- @@ -69,14 +53,6 @@ multiversx\_sdk.wallet.pem\_entry module :undoc-members: :show-inheritance: -multiversx\_sdk.wallet.pem\_entry\_test module ----------------------------------------------- - -.. automodule:: multiversx_sdk.wallet.pem_entry_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.user\_keys module ---------------------------------------- @@ -101,14 +77,6 @@ multiversx\_sdk.wallet.user\_signer module :undoc-members: :show-inheritance: -multiversx\_sdk.wallet.user\_test module ----------------------------------------- - -.. automodule:: multiversx_sdk.wallet.user_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.user\_verifer module ------------------------------------------- @@ -149,14 +117,6 @@ multiversx\_sdk.wallet.validator\_signer module :undoc-members: :show-inheritance: -multiversx\_sdk.wallet.validator\_test module ---------------------------------------------- - -.. automodule:: multiversx_sdk.wallet.validator_test - :members: - :undoc-members: - :show-inheritance: - multiversx\_sdk.wallet.validator\_verifier module -------------------------------------------------