Merge pull request #20 from Catenscia/develop

Develop
Catenscia · Jan 24, 2023 · b024d1b · b024d1b
2 parents 29a161e + 291436f
commit b024d1b
Show file tree

Hide file tree

Showing 14 changed files with 629 additions and 17 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+sphinx:
+   configuration: docs/source/conf.py
+
+python:
+   install:
+   - requirements: requirements-dev.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -26,11 +26,12 @@ Please follow this steps:
 Banches names should reflect the type of change they bring.
 The examples below should fit most needs.
 
-| **Change type** | Description                                            | Name                       |
-|-----------------|--------------------------------------------------------|----------------------------|
-| **Feature**     | For any feature that will be added to the project      | `feature_<feature_name>`   |
-| **Fix**         | For any bug fix on the project                         | `fix_<bug_name>`           |
-| **Refactor**    | For any change that do not impact the functionnalities | `refactor_<refactor_name>` |
-| **Test**        | For any test(s) that will be added to the project      | `test_<test_name>`         |
+| **Change type**   | Description                                            | Name                       |
+|-------------------|--------------------------------------------------------|----------------------------|
+| **Feature**       | For any feature that will be added to the project      | `feature_<feature_name>`   |
+| **Fix**           | For any bug fix on the project                         | `fix_<bug_name>`           |
+| **Refactor**      | For any change that do not impact the functionnalities | `refactor_<refactor_name>` |
+| **Test**          | For any test(s) that will be added to the project      | `test_<test_name>`         |
+| **Documentation** | For any change in the documentation                    | `docs_<change_name>`       |
 
 Many thanks! :heart: :heart: :heart:
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # MxOps
 
-MxOps is a python package created to automate MultiversX smart contracts deployments, calls and querys.
+MxOps is a python package created to automate MultiversX smart contracts deployments, calls and queries.
 Inspired from DevOps tools, it aims to ease and make reproductible any set of these interactions with smart-contracts.
 
 MxOps aims to be useful in these situations:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,16 +29,17 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["myst_parser"]
+extensions = [
+    'myst_parser',
+    'sphinxcontrib.images',
+]
 
 templates_path = ['_templates']
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
-
diff --git a/docs/source/dev_documentation/changelog.md b/docs/source/dev_documentation/changelog.md
@@ -14,6 +14,21 @@
 
 - None
 
+## 0.1.1 - 2023-01-24
+
+### Added
+
+- Readthedocs yaml configuration file to fix compilation
+- Full user tutorial in the sphinx documentation
+
+### Changed
+
+- None
+
+### Removed
+
+- None
+
 ## 0.1.0 - 2023-01-23
 
 First version of MxOps.
diff --git a/docs/source/images/integration_test_contracts_map.svg b/docs/source/images/integration_test_contracts_map.svg
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,12 +7,14 @@ Welcome to MxOps |version| !
 =========================================
 
 You are in the MxOps documentation. Use the left-side pannel or the menu below to navigate where you want to go.
-If you are new here, we recommand going first to the :doc:`user_documentation/overview` section and then to the :doc:`user_documentation/getting_started`.
-
+If you are new here, we recommand going first to the :doc:`user_documentation/overview` section and
+then to the :doc:`user_documentation/getting_started`.
+Otherwise, if you prefer to learn by example, the :doc:`user_documentation/tutorial` section is here for you!
 
 .. toctree::
    :maxdepth: 2
    :caption: User Documentation
+   :numbered:
 
    user_documentation/overview
    user_documentation/getting_started
@@ -21,6 +23,7 @@ If you are new here, we recommand going first to the :doc:`user_documentation/ov
    user_documentation/steps
    user_documentation/values
    user_documentation/execution
+   user_documentation/tutorial
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/user_documentation/overview.md b/docs/source/user_documentation/overview.md
@@ -1,6 +1,6 @@
 # Overview
 
-MxOps is a python package created to automate MultiversX smart contracts deployments, calls and querys.
+MxOps is a python package created to automate MultiversX smart contracts deployments, calls and queries.
 Inspired from DevOps tools, it aims to ease and make reproductible any set of these interactions with smart-contracts.
 
 MxOps aims to be useful in these situations:

diff --git a/docs/source/user_documentation/scenario.md b/docs/source/user_documentation/scenario.md
@@ -30,9 +30,13 @@ Where:
 - Network will be the name of chain used (MAIN, DEV, TEST or LOCAL) for the scenario
 - <my_scenario>.json is the file where all the contract data of the executed scenario are stored
 
-One important note: the files are kept after each executions. This means that you can reuse a `Scenario` and execute new `Scenes` in it. This is very usefull for incremental executions (deploy, upgrade...) or reccurent tasks (complexe claim/compound cycles for example)
+```{note}
+The files are kept after each executions. This means that you can reuse a `Scenario` and execute new `Scenes` in it. This is very usefull for incremental executions (deploy, upgrade...) or reccurent tasks (complexe claim/compound cycles for example)
+```
 
-This also means that their name should be unique for all your projects. Otherwise you may encounter data collision.
+```{warning}
+This also means that `Scenario` names should be unique for all your projects. Otherwise you may encounter data collision.
+```
 
 ## Commands
 

diff --git a/docs/source/user_documentation/steps.md b/docs/source/user_documentation/steps.md
@@ -42,8 +42,11 @@ esdt_transfers:  # optional, ESDTs to send
   - token_identifier: LKMEX-e45d41
     amount: 848491898
     nonce: 721
+check_for_errors: True  # optional, True by default
 ```
 
+`check_for_errors` is the parameter that tells`MxOps` to verify that the transaction went without errors. If an error is found, the execution will be stopped. In some use-cases, for example if you want to launch 100s of txs, you can deactivate this parameter for faster execution.
+
 ## Contract Query Step
 
 This `Step` is used to fetch some data from a contract and save it locally for later use in the `Scenario` (specified at execution time).