-
Notifications
You must be signed in to change notification settings - Fork 12.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for rustdoc-gui tests
- Loading branch information
1 parent
2b8fbe6
commit c8dbb59
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |