From 186cf207966fb9c60d3896448726d4f370523b14 Mon Sep 17 00:00:00 2001 From: Mikael Koli Date: Wed, 24 Nov 2021 23:05:18 +0200 Subject: [PATCH] docs: continued with tutorials and add new classes --- docs/condition_syntax/dependence.rst | 8 +- docs/condition_syntax/execution.rst | 8 +- docs/condition_syntax/fixed_interval.rst | 6 +- docs/condition_syntax/index.rst | 40 ++-- docs/condition_syntax/task_status.rst | 10 +- docs/condition_syntax/timedelta.rst | 4 +- docs/contributing.rst | 8 + docs/examples/session/example.py | 21 +- docs/how_it_works.rst | 44 ++++ docs/index.rst | 36 ++-- docs/reference/arguments.rst | 3 +- docs/reference/baseclasses.rst | 7 + docs/reference/conditions.rst | 3 + docs/reference/index.rst | 4 +- docs/scheduling.png | Bin 0 -> 34106 bytes docs/task_execution.png | Bin 0 -> 71814 bytes docs/tutorial/advanced_guide.rst | 247 ++++++++++++++++++----- docs/tutorial/extending_guide.rst | 57 +++++- docs/tutorial/index.rst | 4 + docs/tutorial/logging_guide.rst | 179 ++++++++++++++++ docs/tutorial/pipeline_guide.rst | 2 +- docs/tutorial/quick_start.rst | 10 +- docs/tutorial/scheduling_guide.rst | 200 ++++++++++++++++++ docs/tutorial/short_guide.rst | 38 +++- docs/user_guide/conditions.rst | 8 +- docs/user_guide/extensions.rst | 60 ------ docs/user_guide/index.rst | 9 +- docs/user_guide/logging.rst | 20 +- docs/user_guide/parameters.rst | 4 +- docs/user_guide/scheduling.rst | 189 ----------------- docs/user_guide/session.rst | 58 ++++++ docs/user_guide/session_config.rst | 35 ---- docs/user_guide/tasks.rst | 42 +++- docs/versions.rst | 17 ++ 34 files changed, 953 insertions(+), 428 deletions(-) create mode 100644 docs/contributing.rst create mode 100644 docs/how_it_works.rst create mode 100644 docs/scheduling.png create mode 100644 docs/task_execution.png create mode 100644 docs/tutorial/logging_guide.rst create mode 100644 docs/tutorial/scheduling_guide.rst delete mode 100644 docs/user_guide/extensions.rst delete mode 100644 docs/user_guide/scheduling.rst create mode 100644 docs/user_guide/session.rst delete mode 100644 docs/user_guide/session_config.rst create mode 100644 docs/versions.rst diff --git a/docs/condition_syntax/dependence.rst b/docs/condition_syntax/dependence.rst index a50a1c27..671a1d17 100644 --- a/docs/condition_syntax/dependence.rst +++ b/docs/condition_syntax/dependence.rst @@ -4,8 +4,12 @@ Task Dependence --------------- -- ``after task ''`` -- ``after task '' [succeeded | failed | finished | terminated]`` +**Syntax** + +.. code-block:: none + + after task '' + after task '' [succeeded | failed | finished | terminated] **True when** diff --git a/docs/condition_syntax/execution.rst b/docs/condition_syntax/execution.rst index 624838bf..1cec2a7f 100644 --- a/docs/condition_syntax/execution.rst +++ b/docs/condition_syntax/execution.rst @@ -6,9 +6,11 @@ Execution on fixed time interval **Syntax** -- ``[hourly | daily | weekly | monthly]`` -- ``[hourly | daily | weekly | monthly] between and `` -- ``[hourly | daily | weekly | monthly] [before | after | starting]