Skip to content

Commit 50cc9b2

Browse files
committed
Update installation instructions
1 parent 4d31676 commit 50cc9b2

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,25 @@ 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
8892
$ pip install -e .
8993
$ make html
9094
```
9195

92-
## Testing
96+
### Testing
9397

9498
```console
9599
# note: -W tells Sphinx to fail on warnings
96100
$ make html linkcheck doctest SPHINXOPTS='-W'
97101
```
98102

99-
## Deploying
103+
### Deploying
100104

101105
**To document a new version of Cylc:**
102106

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

136-
## Nightly Builds
140+
### Nightly Builds
137141

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

0 commit comments

Comments
 (0)