Skip to content

Commit c685718

Browse files
authored
add rtd info
1 parent 305f2dc commit c685718

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ cd docs
2424
make watch
2525
```
2626

27+
## Setting up readthedocs
28+
29+
Readthedocs is a website that hosts the docs for many projects in the Python ecosystem. You can integrate them with your repo by following the instructions here: https://docs.readthedocs.io/en/stable/webhooks.html
30+
31+
You can also have readthedocs make test builds on PRs by following the instructions here: https://docs.readthedocs.io/en/latest/pull-requests.html
2732
## Setting up tests
2833

2934
The best way to do testing for a Matplotlib extension is to use [pytest-mpl](https://github.com/matplotlib/pytest-mpl#about). This project inclues a basic test, but does not pregenerate any baselines images. To make the example test work you first need to generate the baseline with:

0 commit comments

Comments
 (0)