itsscb/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-11-25 09:17:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
rust/tests/rustdoc-gui
History
Michael Howell 3fa98a1507 rustdoc: add a handle that makes sidebar resizing more obvious 
This change is based on some discussion on [lolbinarycat's idea],
but with a more "traditional" design. Specifically, this is the
closest thing I could find to a consensus across many systems I
looked at for inspiration:

- In Jira, resizable sidebars have a stack of four dots.
- In The GIMP, resizable sidebars have a stack of three dots.
- In [old Windows], "panes" are defined to have the same border
  style as a window, which has a raised appearance.
- In [NeXT], a drag point usually had an innie, whether the line in a
  slider or the circle in a scroller; I can also hide and show the
  favorites bar in Workspace by dragging on a circular "grip spot"
- In [old Mac], drag handles for things usually had a "grip track"
  of parallel lines.
- [OSX] kept that, but the "Source List" part of the Finder still had
  the circle grip for a time the same way Workspace did

[lolbinarycat's idea]: https://github.com/rust-lang/rust/pull/139420
[old Windows]: https://archive.org/details/windowsinterface00micr/page/n9/mode/2up
[old Mac]: https://archive.org/details/apple-hig/1996_Human_Interface_Guidelines_for_Mac_OS_8_%28WWDC_Release%29/page/16/mode/2up
[NeXT]: https://archive.org/details/apple-hig/1993%20NeXTSTEP%20User%20Interface%20Guidelines%20-%20Release%203/page/145/mode/2up
[OSX]: https://dn721903.ca.archive.org/0/items/apple-hig/MacOSX_HIG_2005_09_08.pdf#page=267
2025-05-09 12:38:00 -07:00
..
src
Add/update GUI test for impl indent fix
2025-04-24 12:33:29 +02:00
anchor-navigable.goml
…
anchors.goml
rustdoc: make the header show all three buttons
2024-09-10 17:56:06 -07:00
check_info_sign_position.goml
…
check-code-blocks-margin.goml
…
check-stab-in-docblock.goml
Add GUI regression test for code in doc blocks
2024-10-26 15:45:17 +02:00
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 regression test for #137082
2025-02-24 14:27:33 +01:00
code-sidebar-toggle.goml
rustdoc: clean up source sidebar hide button
2023-12-17 23:06:31 -07:00
code-tags.goml
rustdoc: rename /implementors to /impl.trait
2023-10-22 15:47:34 -07:00
codeblock-sub.goml
…
codeblock-tooltip.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
copy-code.goml
Update GUI tests for code example buttons
2024-08-05 11:04:51 +02:00
copy-path.goml
Add rustdoc-gui regression test for #137082
2025-02-24 14:27:33 +01:00
cursor.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
default-settings.goml
…
deref-block.goml
Update GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
docblock-big-code-mobile.goml
Update GUI test
2024-10-26 20:40:59 +02:00
docblock-code-block-line-number.goml
Update rustdoc-gui test
2025-02-14 11:41:28 +01:00
docblock-details.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
docblock-table-overflow.goml
Add/update GUI test for impl indent fix
2025-04-24 12:33:29 +02:00
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
Add GUI regression test for variant structfields margins
2024-10-28 11:16:38 +01:00
font-serif-change.goml
Add GUI test for new "sans serif fonts" setting
2025-01-29 11:01:14 +01:00
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
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07: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
Update rustdoc tests
2025-01-17 22:36:49 +01:00
huge-logo.goml
rustdoc: add test cases for mile wide bar
2024-07-16 13:29:35 -07:00
impl_on_foreign_order.goml
Add GUI test to ensure that implementations on foreign types are in the expected order
2023-11-02 18:02:14 +01:00
impl-block-doc.goml
Improve positioning of "..." in collapsed impl block
2024-12-05 22:50:21 +01:00
impl-default-expansion.goml
…
impl-doc-indent.goml
Add/update GUI test for impl indent fix
2025-04-24 12:33:29 +02:00
impl-doc.goml
Update GUI tests
2024-12-05 22:50:21 +01:00
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 GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
item-info-overflow.goml
Add/update GUI test for impl indent fix
2025-04-24 12:33:29 +02:00
item-info.goml
Add GUI test for item info elements color
2024-12-28 20:54:00 +01:00
item-name-wrap.goml
Remove more CSS classes
2025-01-18 20:29:55 +01:00
item-summary-table.goml
Remove more CSS classes
2025-01-18 20:29:55 +01:00
javascript-disabled.goml
rustdoc: dedup search form HTML
2024-05-05 08:15:08 -07:00
jump-to-def-background.goml
Update rustdoc tests
2025-02-11 14:29:58 +01:00
label-next-to-symbol.goml
Remove more CSS classes
2025-01-18 20:29:55 +01:00
links-color.goml
Remove more CSS classes
2025-01-18 20:29:55 +01:00
list_code_block.goml
…
list-margins.goml
Add GUI regression test for #130622 and for #131223
2024-10-04 18:01:52 +02:00
method-margins.goml
…
methods-left-margin.goml
Update GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
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
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
module-items-font.goml
Remove more CSS classes
2025-01-18 20:29:55 +01:00
no-docblock.goml
rustdoc: rename /implementors to /impl.trait
2023-10-22 15:47:34 -07:00
notable-trait.goml
Align impl doc block with impl keyword
2024-11-13 15:13:31 +01:00
overflow-tooltip-information.goml
…
pocket-menu.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
README.md
Enable --no-sandbox option by default for rustdoc GUI tests
2024-10-04 12:11:23 +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
rustdoc: use better, consistent SVG icons for scraped examples
2025-02-12 16:07:11 -07:00
scrape-examples-color.goml
Simplify CSS but wrapping scraped example into a div and move the title out of the code block
2024-09-02 15:59:00 +02:00
scrape-examples-fonts.goml
…
scrape-examples-layout.goml
Update rustdoc tests
2025-02-11 14:29:58 +01:00
scrape-examples-toggle.goml
Make theme switching closer to reality
2024-04-08 12:14:41 +02:00
search-about-this-result.goml
rustdoc-search: simplify rules for generics and type params
2024-10-30 12:27:48 -07:00
search-corrections.goml
rustdoc-search: pass original names through AST
2024-10-30 10:35:38 -07:00
search-error.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
search-filter.goml
rustdoc: make the header show all three buttons
2024-09-10 17:56:06 -07:00
search-form-elements.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07: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
Remove rustc::existing_doc_keyword lint.
2024-12-17 13:56:10 +11:00
search-result-description.goml
…
search-result-display.goml
rustdoc-gui: fix test cases
2024-09-29 10:02:06 -07:00
search-result-go-to-first.goml
Tweak breadcrumbs list
2024-09-23 09:21:39 -07:00
search-result-impl-disambiguation.goml
rustdoc-search: account for numeric disambiguators on impls
2024-08-06 07:36:12 -07:00
search-result-keyword.goml
Remove rustc::existing_doc_keyword lint.
2024-12-17 13:56:10 +11: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
Add GUI regression test for indent of trait items on mobile
2025-01-24 15:36:52 +01: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
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
settings.goml
Add regression test for #139282
2025-04-07 17:28:46 +02:00
shortcuts.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
sidebar-foreign-impl-sort.goml
Add custom sort for link in rustdoc
2025-02-19 08:35:51 +08:00
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-modnav-position.goml
rustdoc: add test case for modnav position when TOC is off
2024-08-20 16:54:04 -07:00
sidebar-resize-close-popover.goml
rustdoc: add a handle that makes sidebar resizing more obvious
2025-05-09 12:38:00 -07:00
sidebar-resize-setting.goml
rustdoc: add a handle that makes sidebar resizing more obvious
2025-05-09 12:38:00 -07:00
sidebar-resize-window.goml
…
sidebar-resize.goml
rustdoc: add a handle that makes sidebar resizing more obvious
2025-05-09 12:38:00 -07:00
sidebar-source-code-display.goml
rustdoc: adjust spacing and typography in header
2024-10-23 19:15:23 -04: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: add a handle that makes sidebar resizing more obvious
2025-05-09 12:38:00 -07:00
source-anchor-scroll.goml
Update rustdoc tests
2025-02-11 14:29:58 +01:00
source-code-page-code-scroll.goml
Update rustdoc tests
2025-02-11 14:29:58 +01:00
source-code-page.goml
Update rustdoc tests
2025-02-11 14:29:58 +01:00
source-code-wrapping.goml
Rename feature into Word wrap source code
2025-02-22 15:44:14 +01: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
Add GUI regression test for doc struct fields margins
2024-10-27 11:26:45 +01:00
target.goml
rustdoc: animate the :target highlight
2024-08-19 18:14:35 -07: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
Tweak breadcrumbs list
2024-09-23 09:21:39 -07:00
toggle-docs-mobile.goml
Add GUI regression test for indent of trait items on mobile
2025-01-24 15:36:52 +01:00
toggle-docs.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07: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
rustdoc: rename /implementors to /impl.trait
2023-10-22 15:47:34 -07:00
trait-with-bounds.goml
Add GUI test for trait bounds display
2024-07-19 21:31:30 +02:00
type-declation-overflow.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
type-impls.goml
rustdoc: make JS trait impls act more like HTML
2023-10-22 16:51:32 -07:00
unsafe-fn.goml
Remove more CSS classes
2025-01-18 20:29:55 +01: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.