Skip to content
This repository has been archived by the owner on Jan 14, 2024. It is now read-only.

Commit

Permalink
Improve docs - add most important rkd.syntax classes to the tasks api…
Browse files Browse the repository at this point in the history
… docs
  • Loading branch information
blackandred committed Aug 3, 2020
1 parent a7e65c8 commit 94a671c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/usage/tasks-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ Each task must implement a TaskInterface
.. autoclass:: rkd.contract.TaskInterface
:members:

To include a task, wrap it in a declaration
-------------------------------------------

.. autoclass:: rkd.syntax.TaskDeclaration

To create an alias for task or multiple tasks
---------------------------------------------

.. autoclass:: rkd.syntax.TaskAliasDeclaration

Execution context provides parsed shell arguments and environment variables
---------------------------------------------------------------------------

Expand Down

0 comments on commit 94a671c

Please sign in to comment.