diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2021-03-23 21:15:32 +0100 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2021-03-23 21:15:45 +0100 |
| commit | c8dbb59c9d012f58b5dad09fc16c8681fbde0704 (patch) | |
| tree | 60e06040f2e9c21aea3aa7aeb4733f2f29bee415 | |
| parent | 2b8fbe6b0b6db7960828bd2c9a50e52c9a5d0aef (diff) | |
| download | rust-c8dbb59c9d012f58b5dad09fc16c8681fbde0704.tar.gz rust-c8dbb59c9d012f58b5dad09fc16c8681fbde0704.zip | |
Add documentation for rustdoc-gui tests
| -rw-r--r-- | src/test/rustdoc-gui/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/test/rustdoc-gui/README.md b/src/test/rustdoc-gui/README.md new file mode 100644 index 00000000000..499a98a3d22 --- /dev/null +++ b/src/test/rustdoc-gui/README.md @@ -0,0 +1,12 @@ +The tests present here are used to test the generated HTML from rustdoc. The +goal is to prevent unsound/unexpected GUI changes. + +This is using the [browser-ui-test] framework to do so. It works as follows: + +It wraps [puppeteer] to send commands to a web browser in order to navigate and +test what's being currently displayed in the web page. + +You can find more information and its documentation in its [repository][browser-ui-test]. + +[browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/ +[puppeteer]: https://pptr.dev/ |