rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add documentation for rustdoc-gui tests

Browse Source
This commit is contained in:
Guillaume Gomez
2021-03-23 21:15:32 +01:00
parent 2b8fbe6b0b
commit c8dbb59c9d
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/test/rustdoc-gui/README.md Normal file
View File

@@ -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/