Skip to content

Commit

Permalink
Rollup merge of rust-lang#83420 - GuillaumeGomez:rustdoc-gui-tests-do…
Browse files Browse the repository at this point in the history
…c, r=CraftSpider

Add documentation for rustdoc-gui tests

I think a bit of documentation doesn't hurt in this case considering how "out of the ordinary" this is.

r? ``@jyn514``
  • Loading branch information
JohnTitor committed Mar 25, 2021
2 parents 29e64e9 + c8dbb59 commit 72a2d0e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/test/rustdoc-gui/README.md
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 72a2d0e

Please sign in to comment.