Skip to content

Commit

Permalink
Merge pull request #165 from gregoil/update_docs_to_7_13
Browse files Browse the repository at this point in the history
Update docs to rotest 7.13.0
  • Loading branch information
gregoil committed Oct 2, 2019
2 parents 12b392f + 551bbcf commit 4f5a98b
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 5 deletions.
6 changes: 4 additions & 2 deletions docs/advanced/blocks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ TestBlock
to ask for values for the block (values are passed via ``common``,
``parametrize``, previous blocks passing them as ``outputs``, or as
requested resources of the block or its containers).
You can define a default value to BlockInput to assign if non is supplied
You can define a default value to BlockInput to assign if none is supplied
(making it an optional input). For example, defining in the block's scope

.. code-block:: python
Expand All @@ -66,7 +66,9 @@ TestBlock
will validate that the block instance will have a value for 'field_name'
before running the parent flow (and unless another value is supplied,
set for the block's instance: self.other_field=1).
set for the block's instance: self.other_field=1). The static validation
would also make sure that the parameters passed to blocks (via ``parametrize``
or ``common``) exist as inputs, to help avoiding syntactic errors and stale code.

#. ``outputs``: define class fields and assign them to instances of BlockOutput
to share values from the instance (self) to the parent and siblings.
Expand Down
20 changes: 20 additions & 0 deletions docs/configurations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,26 @@ in the following ways:
* There is no default value.

Smart client
------------

.. envvar:: ROTEST_SMART_CLIENT

Enable or disable the smart client, which keeps resources from one test to the next.

To define smart client behavior, use the following methods:

* Define :envvar:`ROTEST_SMART_CLIENT` with to be 'True' or 'False'.

* Define ``smart_client`` in the configuration file:

.. code-block:: yaml
rotest:
smart_client: false
* Use the default, which is ``True``.

Artifacts Directory
-------------------

Expand Down
13 changes: 12 additions & 1 deletion docs/intro/basic_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,18 @@ database of all the instances. Rotest uses the infrastructure of Django, to
define this database, and to make use of the Django's admin frontend to enable
changing it.

First, create a Django project, using:
The fastest way to create a Rotest project is to use the cookiecutter:

.. code-block:: console
$ pip install cookiecutter
$ cookiecutter https://github.com/gregoil/cookiecutter-rotest
For further reading on cookiecutters, see https://cookiecutter.readthedocs.io/

Alternatively, you can create the project manually:

First, create a Django project, using

.. code-block:: console
Expand Down
4 changes: 3 additions & 1 deletion docs/intro/using_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ In this tutorial, you'll learn:
Creating a Resource Class
=========================

In the root of your project, create a new Django application:
If you used ``rotest-cookiecutter`` to create the project earlier,
you should already have a Django applications to put the resources in.
Otherwise create one manually in the root of your project:

.. code-block:: console
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"xlrd",
"pathlib2",
"flake8",
"pylint",
"pylint<2.4",
"waiting",
]
},
Expand Down

0 comments on commit 4f5a98b

Please sign in to comment.