Skip to content

Commit c660a1c

Browse files
Merge pull request #912 from MetRonnie/small-fix
Replace generic links to the user guide
2 parents 4423317 + bd50f3e commit c660a1c

File tree

10 files changed

+13
-12
lines changed

10 files changed

+13
-12
lines changed

src/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,8 @@ def generate_task_icon_modifier_rst():
200200
# linkcheck has trouble handling GH anchors
201201
'https?://github.com/.*#.*',
202202
'https?://matrix.to/.*#.*',
203+
# Blocked by bot protection:
204+
'https?://www.iso.org',
203205
]
204206

205207
# -- Options for Slides output ----------------------------------------------

src/hyperlinks.rst.include

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
.. _Apollo Client: https://www.apollographql.com/docs/react/
44
.. _Configurable HTTP Proxy: https://github.com/corridor/configurable-http-proxy
55
.. _CurveZMQ: http://curvezmq.org/page:read-the-docs
6-
.. _Cylc User Guide: https://cylc.github.io/cylc-doc/latest/html/index.html
76
.. _Cylc Workflow Design Guide: https://cylc.github.io/cylc-doc/latest/html/workflow-design-guide/index.html
87
.. _Cylc: https://cylc.github.io/
98
.. _Cylc Discourse Forum (7-to-8 topic): https://cylc.discourse.group/c/cylc/7-to-8/13

src/tutorial/furthertopics/clock-triggered-tasks.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,4 +172,4 @@ Summary
172172
* Clock triggers are a built in example of :ref:`Section External Triggers`.
173173
* Clock triggers can only be used in datetime cycling workflows.
174174

175-
For more information see the `Cylc User Guide`_.
175+
For more information see the :ref:`Cylc User Guide <Built-in Clock Triggers>`.

src/tutorial/furthertopics/message-triggers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ complete.
2727
We could also set up :term:`message triggers <message trigger>` to, for example,
2828
send an email to inform us that a submission has failed, making use of Cylc's
2929
task event handling system. More information is available on these in the
30-
`Cylc User Guide`_.
30+
:ref:`Cylc User Guide <MessageTriggers>`.
3131

3232

3333
:term:`Message triggers <message trigger>` provide a superior solution to

src/tutorial/furthertopics/queues.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ The customers will obviously have to wait!
116116
Further Reading
117117
---------------
118118

119-
For more information, see the `Cylc User Guide`_.
119+
For more information, see the :ref:`Cylc User Guide <InternalQueues>`.

src/tutorial/runtime/configuration-consolidation/families.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Graphing
151151
Run as soon as all of the family members have completed (i.e. have each
152152
either succeeded or failed).
153153

154-
For more information on family triggers see the `Cylc User Guide`_.
154+
For more information on family triggers see the :ref:`Cylc User Guide <FamilyTriggers>`.
155155

156156
.. ifslides::
157157

src/tutorial/runtime/configuration-consolidation/parameters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Parameters can be either strings or integers:
177177

178178
.. ifnotslides::
179179

180-
For more information see the `Cylc User Guide`_.
180+
For more information see the :ref:`Cylc User Guide <User Guide Param>`.
181181

182182
.. ifslides::
183183

src/tutorial/scheduling/datetime-cycling.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,8 @@ cycle point by:
232232

233233
* Using an `inferred recurrence`_ instead (i.e. ``T00``).
234234
* Overriding the recurrence start point (i.e. ``T00/P1D``)
235-
* Using ``[scheduling]initial cycle point constraints`` to
236-
constrain the initial cycle point (e.g. to a particular time of day). See
237-
the `Cylc User Guide`_ for details.
235+
* Using :cylc:conf:`[scheduling]initial cycle point constraints` to
236+
constrain the initial cycle point (e.g. to a particular time of day).
238237

239238
The Initial and Final Cycle Points
240239
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

src/tutorial/scheduling/further-scheduling.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ to handle events within your code (custom outputs).
5050

5151
.. ifnotslides::
5252

53-
*For more information see the* `Cylc User Guide`_.
53+
For more information see the :ref:`Cylc User Guide <TriggerTypes>`.
54+
5455

5556

5657
.. _tutorial-clock-triggers:

src/workflow-design-guide/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ workflows), and end with some pointers to future developments.
2222

2323
A good working knowledge of Cylc and Rose is assumed. For further details,
2424
please consult the:
25-
26-
- `Cylc User Guide`_
25+
26+
- :ref:`Cylc User Guide <user guide>`
2727
- `Rose Documentation`_
2828

2929
.. note::

0 commit comments

Comments
 (0)