rust/rustdoc-gui at 00bfd702dc8c3b760b4f965fd059a5f1db8bb2b1 - rust

History

Matthias Krüger c2b085b4d4 Rollup merge of #128339 - GuillaumeGomez:click-code-example, r=notriddle [rustdoc] Make the buttons remain when code example is clicked Follow-up of https://github.com/rust-lang/rust/pull/125779. One current issue we have with "run" button and the newly added copy code button is that if you're on mobile devices, you can't use them. I took a look at how `mdbook` is handling it and when you click on a code example, they show the buttons. I think it's a really good idea as if you want to copy the code on your mobile device, you will click on it, showing the buttons. Feature can be tested [here](https://rustdoc.crud.net/imperio/click-code-example/foo/struct.Bar.html). r? `@notriddle`		2024-07-30 04:31:55 +02:00
..
src	Add regression test for items list size (#128023 )	2024-07-22 11:33:03 +02:00
anchor-navigable.goml
anchors.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
basic-code.goml
check_info_sign_position.goml
check-code-blocks-margin.goml
check-stab-in-docblock.goml
code-blocks-overflow.goml
code-color.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
code-example-buttons.goml	Add rustdoc GUI test to check click on code examples	2024-07-29 21:14:36 +02:00
code-sidebar-toggle.goml	rustdoc: clean up source sidebar hide button	2023-12-17 23:06:31 -07:00
code-tags.goml
codeblock-sub.goml
codeblock-tooltip.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
copy-code.goml	Make "copy code" button the same size as the "copy path" button	2024-07-18 14:16:29 +02:00
copy-path.goml	Add GUI test for copy path button	2024-04-17 16:56:14 +02:00
cursor.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
default-settings.goml
docblock-big-code-mobile.goml
docblock-code-block-line-number.goml	Make theme switching closer to reality	2024-04-08 12:14:41 +02:00
docblock-details.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
docblock-table-overflow.goml
docblock-table.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
duplicate-macro-reexport.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
enum-variants.goml
escape-key.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
extend-css.goml
fields.goml
font-weight.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
globals.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
go-to-collapsed-elem.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
hash-item-expansion.goml
headers-color.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
headings-anchor.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
headings.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
help-page.goml	Don't call `switch-theme` function	2024-06-29 11:56:06 +02:00
hide-mobile-topbar.goml
highlight-colors.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
huge-collection-of-constants.goml
huge-logo.goml	rustdoc: add test cases for mile wide bar	2024-07-16 13:29:35 -07:00
impl_on_foreign_order.goml
impl-default-expansion.goml
impl-doc.goml
implementors.goml
item-decl-colors.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
item-decl-comment-highlighting.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
item-info-alignment.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
item-info-overflow.goml
item-info.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
item-name-wrap.goml	Add regression test for items list size (#128023 )	2024-07-22 11:33:03 +02:00
item-summary-table.goml
javascript-disabled.goml	rustdoc: dedup search form HTML	2024-05-05 08:15:08 -07:00
jump-to-def-background.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
label-next-to-symbol.goml	rustdoc: properly handle path wrapping	2024-07-29 10:31:02 -07:00
links-color.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
list_code_block.goml
method-margins.goml
mobile-crate-name.goml	Add regression test for #120471 to ensure that long crate name are handled as expected on mobile	2024-01-31 16:40:23 +01:00
mobile.goml
module-items-font.goml
no-docblock.goml
notable-trait.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
overflow-tooltip-information.goml
pocket-menu.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
README.md
run-on-hover.goml	Unify UI between code block buttons and top buttons	2024-07-18 14:16:29 +02:00
rust-logo.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
scrape-examples-button-focus.goml
scrape-examples-color.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
scrape-examples-fonts.goml
scrape-examples-layout.goml
scrape-examples-toggle.goml	Make theme switching closer to reality	2024-04-08 12:14:41 +02:00
search-corrections.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
search-error.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-filter.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-form-elements.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-input-mobile.goml
search-keyboard.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
search-no-result.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-reexport.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-result-color.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
search-result-description.goml
search-result-display.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-result-go-to-first.goml	rustdoc: update test cases	2024-04-09 20:22:13 -07:00
search-result-impl-disambiguation.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
search-result-keyword.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
search-tab-change-title-fn-sig.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
search-tab.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
search-title.goml	Add rustdoc GUI test to check title with and without search	2024-07-27 12:12:16 +02:00
setting-auto-hide-content-large-items.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
setting-auto-hide-item-methods-docs.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
setting-auto-hide-trait-implementations.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
setting-go-to-only-result.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00
settings-button.goml	Add GUI regression test for setting's cog color	2024-05-05 20:07:12 +02:00
settings.goml	Add GUI regression test for setting's cog color	2024-05-05 20:07:12 +02:00
shortcuts.goml
sidebar-links-color.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
sidebar-macro-reexport.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
sidebar-mobile-scroll.goml
sidebar-mobile.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
sidebar-resize-close-popover.goml	rustdoc: hide modals when resizing the sidebar	2024-01-08 09:54:05 -07:00
sidebar-resize-setting.goml	Fix corner cases when dealing with mobile mode	2023-12-19 19:50:53 -07:00
sidebar-resize-window.goml
sidebar-resize.goml
sidebar-source-code-display.goml	Update browser-ui-test version to `0.18.0`	2024-06-27 00:04:23 +02:00
sidebar-source-code.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
sidebar.goml	rustdoc: fix `current` class on sidebar modnav	2024-07-18 12:06:21 -07:00
source-anchor-scroll.goml	rustdoc: use `<wbr>`-tolerant function to check text contents	2024-07-29 08:46:11 -07:00
source-code-page-code-scroll.goml	Update `source-code-page-code-scroll.goml` GUI test	2024-07-21 12:47:34 +02:00
source-code-page.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
src-font-size.goml
stab-badge.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
stab-in-doc.goml	Add regression test for stab display in doc blocks	2024-07-21 11:52:24 +02:00
struct-fields.goml
target.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
theme-change.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
theme-defaults.goml
theme-in-history.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
toggle-click-deadspace.goml	rustdoc: update test cases	2024-04-09 20:22:13 -07:00
toggle-docs-mobile.goml
toggle-docs.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
toggle-implementors.goml
toggled-open-implementations.goml
tooltip-over-sidebar.goml	rustdoc ui: adjust tooltip z-index to be above sidebar	2023-12-31 20:31:56 +01:00
trait-sidebar-item-order.goml
trait-with-bounds.goml	Add GUI test for trait bounds display	2024-07-19 21:31:30 +02:00
type-declation-overflow.goml	Reduce width to ensure that the name is wider and thus still triggering the scroll	2024-07-19 21:31:30 +02:00
type-impls.goml
unsafe-fn.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
utils.goml	Make theme switching closer to reality	2024-04-08 12:14:41 +02:00
warning-block.goml	Use `include` command to reduce code duplication	2024-04-05 21:38:55 +02:00
where-whitespace.goml	Update to new browser-ui-test version	2024-04-01 22:25:01 +02:00

README.md

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 tests/rustdoc-gui --stage 1 --test-args --debug

If you don't want to run in headless mode (helpful to debug sometimes), you can use --no-headless:

$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --no-headless

To see the supported options, use --help.

Important to be noted: if the chromium instance crashes when you run it, you might need to use --no-sandbox to make it work:

$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --no-sandbox