Skip to content

Commit f2bfe24

Browse files
authored
Merge pull request #330 from MetRonnie/db-diagram
Minor correction to DB diagram
2 parents 384e5db + 2fdaa91 commit f2bfe24

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ We use a few custom Sphinx extensions, for details see
8282
[![test](https://github.com/cylc/cylc-doc/workflows/test/badge.svg?branch=master&event=push)](https://github.com/cylc/cylc-doc/actions?query=workflow%3Atest)
8383
[![nightly](https://github.com/cylc/cylc-doc/workflows/nightly/badge.svg)](https://github.com/cylc/cylc-doc/actions?query=workflow%3Anightly)
8484

85+
### Installation
86+
87+
Note: you may need to install `graphviz` first (e.g. `conda install graphviz`).
88+
8589
```console
8690
$ git clone [email protected]:cylc/cylc-doc.git cylc-doc
8791
$ cd cylc-doc
@@ -136,14 +140,14 @@ allows it to pick up changes to autodocumented items in the source code.
136140
> i.e. `pip install -e <repo>` for this to work.
137141
> **Note:** This might not work for all filesystems.
138142
139-
## Testing
143+
### Testing
140144

141145
```console
142146
# note: -W tells Sphinx to fail on warnings
143147
$ make html linkcheck doctest SPHINXOPTS='-W'
144148
```
145149

146-
## Deploying
150+
### Deploying
147151

148152
**To document a new version of Cylc:**
149153

@@ -180,7 +184,7 @@ $ make html linkcheck doctest SPHINXOPTS='-W'
180184
This has not been automated on-purpose, though if it becomes a problem
181185
we could potentially setup a chron job to squash all but the last N commits.
182186

183-
## Nightly Builds
187+
### Nightly Builds
184188

185189
The `nightly` action builds `cylc-doc:master` against `cylc-flow:master`
186190
and pushes the result up to `upstream/gh-pages`.

src/ext/database_diagram.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ def get_relationships():
5656
CylcWorkflowDAO.TABLE_TASK_LATE_FLAGS],
5757
[CylcWorkflowDAO.TABLE_TASK_POOL, ONE_TO_MANY,
5858
CylcWorkflowDAO.TABLE_TASK_OUTPUTS],
59+
[CylcWorkflowDAO.TABLE_TASK_POOL, ONE_TO_MANY,
60+
CylcWorkflowDAO.TABLE_TASK_PREREQUISITES],
5961
[CylcWorkflowDAO.TABLE_TASK_POOL, ONE_TO_ONE,
6062
CylcWorkflowDAO.TABLE_TASK_TIMEOUT_TIMERS]
6163
]

src/release-note.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. note::
22

3-
Cylc |release| is the final *beta* pre-release of Cylc 8. It is largely
3+
Cylc |release| is a Cylc 8 *release candidate*. It is largely
44
complete and can be used to manage real workflows, but it has not yet been
55
heavily tested by users. Python 2 based Cylc 7 is stable and still available
66
if needed for production systems.

0 commit comments

Comments
 (0)