Skip to content

Commit 6517ef9

Browse files
hjoliverMetRonnie
authored andcommitted
Merge pull request #540 from oliver-sanders/fix-tutorial-example
Fix tutorial example (cherry picked from commit 6a76c70)
1 parent 0e9bfb7 commit 6517ef9

File tree

2 files changed

+27
-20
lines changed

2 files changed

+27
-20
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,20 @@ We use a few custom Sphinx extensions, for details see
8484

8585
### Installation
8686

87-
Note: you may need to install `graphviz` first (e.g. `conda install graphviz`).
87+
### Non Python Dependencies
88+
89+
There are two non-Python dependencies which must be installed:
90+
91+
* `graphviz`
92+
* `enchant`
93+
94+
E.G. with Conda/Mamba:
95+
96+
```console
97+
$ mamba install -c conda-forge graphviz enchant
98+
```
99+
100+
### Checkout & Install
88101

89102
```console
90103
$ git clone [email protected]:cylc/cylc-doc.git cylc-doc

src/tutorial/scheduling/datetime-cycling.rst

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -151,33 +151,27 @@ Recurrence Formats
151151
As with integer cycling, recurrences start at the :term:`initial cycle
152152
point` by default. We can override this in two ways:
153153

154-
By giving an arbitrary start cycle point (``datetime/recurrence``):
154+
.. rubric::
155+
By giving an arbitrary start cycle point (``datetime/recurrence``):
155156

156-
.. csv-table::
157-
:header: Example, Description
158-
:align: left
159-
:widths: 30, 70
160-
161-
``2000/P4Y``, "Every fourth year, starting with the year 2000"
162-
``2000-01-01T00/T00``, "Every day at midnight, starting on the 1st of January 2000"
163-
``2000-01-01T12/T00``, "Every day at midnight, starting on the first midnight
164-
after the 1st of January at 12:00 (i.e. ``2000-01-02T00``)."
157+
``2000/P4Y``
158+
Every fourth year, starting with the year 2000.
159+
``2000-01-01T00/P1D``
160+
Every day at midnight, starting on the 1st of January 2000.
165161

166162
.. nextslide::
167163

168164
.. _tutorial-cylc-datetime-offset-icp:
169165

170-
By offset, relative to the initial cycle point (``offset/recurrence``).
171-
The offset must be an ISO8601 duration preceded by a plus character:
166+
.. rubric::
167+
By offset, relative to the initial cycle point (``offset/recurrence``).
172168

173-
.. csv-table::
174-
:header: Example, Description
175-
:align: left
176-
:widths: 30, 70
169+
The offset must be an ISO8601 duration preceded by a plus character:
177170

178-
``+P1Y/P1Y``, every year starting one year after the initial cycle point.
179-
``+PT1H/T00``, "every day starting on the first midnight after the point one
180-
hour after the initial cycle point."
171+
``+PT1H/PT1H``
172+
Every hour starting one hour after the initial cycle point.
173+
``+P1Y/P1Y``
174+
Every year starting one year after the initial cycle point.
181175

182176
Durations and the Initial Cycle Point
183177
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)