rust/src/test/rustdoc-gui
Jacob Hoffman-Andrews c790128c3c Improve wrapping on settings page
Previously, the radio button choices for themes would wrap awkwardly on
narrow screens. With this change, the group of choices will prefer
bumping down to the next line together, leaving the setting name on its
own line.

Also fix some minor spacing issues:

 - Align the setting name vertically with the radio button choices.
 - Use margin instead of padding for most spacing choices.
 - Use no margin/padding on the right-hand side.
2022-01-31 01:46:10 -08:00
..
src Add white-space: nowrap to links in the sidebar 2022-01-24 20:19:09 -08:00
anchor-navigable.goml Outdent method headings so they stand out 2021-10-23 11:50:11 -07:00
anchors.goml tweak all sidebar colours 2022-01-23 10:43:06 +00:00
auto-hide-trait-implementations.goml Add GUI test for auto-hide-trait-implementations setting 2021-07-16 15:15:23 +02:00
basic-code.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
basic.goml * Remove left margin on items declaration at the top of their documentation page 2021-10-18 15:06:38 +02:00
check-code-blocks-margin.goml Rename ID "main" into "main-content" 2021-12-02 14:17:20 +01:00
check_info_sign_position.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
code-blocks-overflow.goml Simplify and unify rustdoc sidebar styles 2022-01-18 10:43:14 -08:00
code-color.goml Add test for code blocks color 2021-08-28 11:44:02 +02:00
code-sidebar-toggle.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
code-tags.goml [rustdoc] Wrap code blocks in <code> tag 2021-08-19 10:30:08 +02:00
default-settings.goml Add tests for default-settings 2021-07-22 12:58:59 +02:00
docblock-big-code-mobile.goml Add test for <code> in doc blocks on mobile 2021-10-10 14:24:40 +02:00
docblock-code-block-line-number.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
docblock-table-overflow.goml Simplify and unify rustdoc sidebar styles 2022-01-18 10:43:14 -08:00
escape-key.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
font-weight.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
hash-item-expansion.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
headers-color.goml Rollup merge of #91834 - GuillaumeGomez:improve-gui-test-readability, r=jsha 2021-12-19 00:38:39 +01:00
headings.goml Remove horizontal lines at top of page 2022-01-18 18:45:43 -08:00
huge-collection-of-constants.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
impl-default-expansion.goml Rename ID "main" into "main-content" 2021-12-02 14:17:20 +01:00
implementors.goml Add tests for implementors associated types display 2021-09-01 11:01:42 +02:00
item-info-width.goml Simplify and unify rustdoc sidebar styles 2022-01-18 10:43:14 -08:00
item-summary-table.goml Add test to ensure tables are not inside items summary 2021-07-21 20:06:06 +02:00
javascript-disabled.goml Hide search bar in noscript.css 2021-10-31 12:41:06 -07:00
jump-to-def-background.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
label-next-to-symbol.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
list_code_block.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
mobile.goml Improve wrapping on settings page 2022-01-31 01:46:10 -08:00
module-items-font.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
overflow-tooltip-information.goml Fix scrollbars appearing on information tooltip on mac when they shouldn't 2021-10-25 11:40:13 +02:00
README.md Allow to pass arguments to rustdoc-gui tool 2021-06-16 11:54:19 +02:00
run-on-hover.goml Make Run button visible on hover 2022-01-05 10:07:22 -05:00
rust-logo.goml Add GUI test for rust logo style in the sidebars 2022-01-11 13:57:17 +01:00
search-filter.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-input-mobile.goml Move rustdoc-gui rust libraries into their own folder and prepare the field for more libraries 2021-05-11 20:56:16 +02:00
search-result-color.goml Update browser-ui-test version and improve rustdoc-gui tests readability 2021-12-12 18:28:58 +01:00
search-result-colors.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-result-description.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
search-result-display.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-result-go-to-first.goml Rename ID "main" into "main-content" 2021-12-02 14:17:20 +01:00
search-result-keyword.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
search-tab-selection-if-current-is-empty.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
shortcuts.goml Update browser-ui-test version 2021-06-19 14:19:39 +02:00
sidebar-macro-reexport.goml Add test for duplicated sidebar entries for reexported macro 2021-10-20 15:44:16 +02:00
sidebar-mobile.goml Fix scroll offset when jumping to internal id 2022-01-19 12:45:16 -08:00
sidebar-source-code.goml Simplify and unify rustdoc sidebar styles 2022-01-18 10:43:14 -08:00
sidebar.goml Add white-space: nowrap to links in the sidebar 2022-01-24 20:19:09 -08:00
source-code-page.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
src-font-size.goml Add test for [src] font-size in headers 2022-01-05 17:35:06 +01:00
theme-change.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
toggle-click-deadspace.goml Fix clicking on anchors inside summary tags. 2021-11-24 10:46:55 -08:00
toggle-docs-mobile.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
toggle-docs.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
toggle-implementors.goml Remove implementors setting 2021-09-01 20:34:51 +02:00
toggled-open-implementations.goml Update browser-ui-test version 2021-06-22 11:11:45 +02:00
trait-sidebar-item-order.goml Add missing GUI test explanations 2022-01-21 20:41:47 +01:00
type-declation-overflow.goml rustdoc: fix overflow-wrap for table layouts 2022-01-20 15:53:08 -08:00

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.

If you need to have more information on the tests run, you can use --test-args:

$ ./x.py test src/test/rustdoc-gui --stage 1 --jobs 8 --test-args --debug

There are three options supported:

  • --debug: allows to see puppeteer commands.
  • --no-headless: disable headless mode so you can see what's going on.
  • --show-text: by default, text isn't rendered because of issues with fonts, it enables it back.