Skip to content

Commit

Permalink
remove tests and constants from the docs & update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@popenta
popenta committed Apr 3, 2024
1 parent c732367 commit f93d365
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 290 deletions.
11 changes: 11 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 -------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 0 additions & 8 deletions docs/multiversx_sdk.core.proto.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
88 changes: 0 additions & 88 deletions docs/multiversx_sdk.core.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------

Expand All @@ -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
----------------------------------

Expand All @@ -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
---------------------------------

Expand All @@ -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
-------------------------------------------

Expand All @@ -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
----------------------------------

Expand All @@ -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
--------------------------------------

Expand All @@ -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
--------------------------------------------------

Expand All @@ -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
----------------------------------

Expand All @@ -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
---------------------------------------

Expand All @@ -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
-------------------------------------

Expand Down
48 changes: 0 additions & 48 deletions docs/multiversx_sdk.core.transaction_builders.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------------------------------------------------------------

Expand All @@ -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
----------------------------------------------------------------

Expand All @@ -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
-----------------------------------------------------------------

Expand All @@ -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
----------------------------------------------------------------------

Expand All @@ -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
----------------------------------------------------------------------

Expand All @@ -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
---------------

Expand Down
8 changes: 0 additions & 8 deletions docs/multiversx_sdk.core.transaction_parsers.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------------------------------------------------------------------------------

Expand Down
48 changes: 0 additions & 48 deletions docs/multiversx_sdk.core.transactions_factories.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------------------------------------------------------

Expand All @@ -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
----------------------------------------------------------------------------------

Expand All @@ -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
------------------------------------------------------------------------------------------

Expand All @@ -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
-----------------------------------------------------------------------------------

Expand Down Expand Up @@ -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
---------------

Expand Down
Loading

0 comments on commit f93d365

Please sign in to comment.