Skip to content

Commit d0b4a6b

Browse files
authored
Install graphviz. Add note to docs (#234)
1 parent 585a90c commit d0b4a6b

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

.github/workflows/gh-pages.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@ on:
66
- main
77
workflow_dispatch:
88

9+
# NOTE: If you modify this file to install a package with pip or apt, please
10+
# verify if we need the same package added to our readthedocs build.
911
jobs:
1012
# Ref: https://stackoverflow.com/questions/57989790/using-github-actions-to-publish-documentation
1113
deploy:
1214
runs-on: ubuntu-latest
1315
steps:
1416
- uses: actions/checkout@v3
1517

18+
- name: Install apt packages
19+
run: |
20+
sudo apt-get install -y graphviz
21+
1622
- name: Set up Python
1723
uses: actions/setup-python@v4
1824
with:

.readthedocs.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
version: 2
22

3+
# NOTE: If you modify this file to install a package with pip or apt, please
4+
# verify if we need the same package added to our CI.
35
build:
46
os: ubuntu-20.04
57
tools:

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ source venv/bin/activate
111111
# Open <http://localhost:8000/> in your browser
112112
```
113113

114+
> NOTE: When you modify the packages installed with apt or pip, please verify
115+
> if the change needs to be applied to either or to both of CI and readthedocs.
116+
> ReadTheDocs builds and deploys previews. CI builds and deploys production
117+
> (GitHub Actions). Failing to update both may result in previews generated
118+
> correctly, but failure to deploy the production version after the pull request
119+
> gets merged.
120+
114121
## Other Resources
115122

116123
General discussion of [Common Workflow Language][cwl-site] project

0 commit comments

Comments
 (0)