user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/tests/rustdoc-gui
History
Stuart Cook 88df8fd3ef
Rollup merge of #151091 - hide-deprecated-items, r=lolbinarycat 
Add new "hide deprecated items" setting in rustdoc

This PR adds a new JS setting which allows the JS to hide deprecated items. This is especially useful for crates like `std` which accumulates deprecated items but never removes them.

Nicely enough, the "deprecation" information was already in the search index, meaning I didn't need to change anything there. Before this PR, it was only used to make the deprecated items rank lower. Well now it's also used to generate an extra CSS class, allowing the JS setting to work.

This is taking over https://github.com/rust-lang/rust/pull/149551.

This feature got approved by the rustdoc team in the [meeting of december](https://rust-lang.zulipchat.com/#narrow/channel/393423-t-rustdoc.2Fmeetings/topic/2025-12-08/near/562553156).

You can give it a try [here](https://rustdoc.crud.net/imperio/hide-deprecated-items/foo/index.html).

r? @lolbinarycat
2026-01-20 18:00:09 +11:00
..
src Add rustdoc GUI test to ensure that the "hide deprecated items" setting is working as expected 2026-01-19 21:37:15 +01:00
anchor-navigable.goml Fix trait method anchor disappearing before user can click on it 2026-01-08 21:47:12 +01:00
anchors.goml Add check for trait impl method anchor 2026-01-08 21:47:12 +01:00
check-code-blocks-margin.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
check-stab-in-docblock.goml Add GUI regression test for code in doc blocks 2024-10-26 15:45:17 +02:00
check_info_sign_position.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
code-blocks-overflow.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
code-color.goml Use include command to reduce code duplication 2024-04-05 21:38:55 +02:00
code-example-buttons.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07: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 Migrate to 0.16.0 browser-ui-test version 2023-05-11 11:34:22 +02:00
codeblock-tooltip.goml Use include command to reduce code duplication 2024-04-05 21:38:55 +02:00
collapse-trait-impl.goml better checks 2025-05-11 08:02:19 +02:00
copy-code.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
copy-path.goml Add rustdoc-gui regression test for #137082 2025-02-24 14:27:33 +01:00
cursor.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
default-settings.goml Migrate GUI colors test to original CSS color format 2023-09-23 20:03:03 +02:00
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 Add GUI regression test for disabled line numbers 2025-12-26 20:13:27 +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 Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
escape-key.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
extend-css.goml Add/update tests for --extend-css option 2023-04-12 20:07:10 +02:00
fields.goml Add GUI regression test for variant structfields margins 2024-10-28 11:16:38 +01:00
font-serif-change.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
font-weight.goml rustdoc: use <wbr>-tolerant function to check text contents 2024-07-29 08:46:11 -07:00
globals.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07: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 Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
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-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
hide-mobile-topbar.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
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-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
impl-block-doc.goml Improve positioning of "..." in collapsed impl block 2024-12-05 22:50:21 +01:00
impl-default-expansion.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
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
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
implementors.goml Make implementors list visible only when filled 2025-12-10 16:18:22 +01:00
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 rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07: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 Fix changes coming from browser-ui-test version update 2026-01-02 20:21:44 +01:00
list-margins.goml Add GUI regression test for #130622 and for #131223 2024-10-04 18:01:52 +02:00
list_code_block.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
macro-expansion.goml Improve code and add test with macro coming from another file from the same crate 2025-08-23 10:57:14 +02:00
method-margins.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
methods-left-margin.goml Update GUI tests for documentation indent changes 2024-11-12 17:58:10 +01:00
mobile-crate-name.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
mobile.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
module-items-font.goml Add tests for doc(attribute = "...") attribute 2025-08-28 15:56:30 +02:00
no-docblock.goml rustdoc: rename /implementors to /impl.trait 2023-10-22 15:47:34 -07:00
notable-trait.goml Reduce flakyness for tests/rustdoc-gui/notable-trait.goml 2026-01-13 10:22:34 +01:00
overflow-tooltip-information.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
pocket-menu.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -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 Update rustdoc GUI tests 2025-07-01 15:49:45 +02:00
scrape-examples-color.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
scrape-examples-fonts.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
scrape-examples-ice-links.goml Ensure that --html-after-content option is used to check scrape_examples_ice rustdoc GUI test 2025-09-05 15:13:08 +02:00
scrape-examples-layout.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
scrape-examples-toggle.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-about-this-result.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-corrections.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-error.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-filter.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
search-form-elements.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-input-mobile.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-keyboard.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-no-result.goml Use include command to reduce code duplication 2024-04-05 21:38:55 +02:00
search-reexport.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-result-color.goml fix rustdoc tests broke by trait item filtering 2025-10-02 15:28:00 -05:00
search-result-description.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-result-display.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-result-go-to-first.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-result-impl-disambiguation.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-result-keyword.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-tab-change-title-fn-sig.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
search-tab.goml fix rustdoc tests broke by trait item filtering 2025-10-02 15:28:00 -05:00
search-throbber.goml rustdoc-search: add test case for throbber 2025-10-07 12:59:58 -07:00
search-title.goml rustdoc-search: add test case for all/index.html search 2025-09-25 15:45:11 -07:00
setting-auto-hide-content-large-items.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
setting-auto-hide-item-methods-docs.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
setting-auto-hide-trait-implementations.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
setting-go-to-only-result.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
setting-hide-deprecated.goml Add test for search results of not yet deprecated search items 2026-01-19 23:14:09 +01:00
settings-button.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
settings.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
shortcuts.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -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 Add tests for doc(attribute = "...") attribute 2025-08-28 15:56:30 +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 rustdoc: use CSS overscroll-behavior instead of JavaScript 2023-04-12 10:31:06 -07:00
sidebar-mobile.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01: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 Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
sidebar-resize-setting.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
sidebar-resize-window.goml rustdoc: fix resize trouble with mobile 2023-10-11 12:15:33 -07:00
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 Fix changes coming from browser-ui-test version update 2026-01-02 20:21:44 +01:00
sidebar-source-code.goml squash fix render_call_locations panic when default span points at file outside of local_sources 2025-09-02 01:38:23 +02:00
sidebar.goml fix rustdoc tests broke by trait item filtering 2025-10-02 15:28:00 -05:00
source-anchor-scroll.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
source-code-page-code-scroll.goml Update rustdoc tests 2025-02-11 14:29:58 +01:00
source-code-page.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
source-code-wrapping.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
src-font-size.goml rustdoc: use src consistently over source in code 2023-07-14 16:38:01 -07:00
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 functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
theme-defaults.goml Use functions more in rustdoc GUI tests 2026-01-08 21:49:29 +01:00
theme-in-history.goml Use include command to reduce code duplication 2024-04-05 21:38:55 +02:00
toggle-click-deadspace.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
toggle-docs-mobile.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
toggle-docs.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -07:00
toggle-implementors.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
toggled-open-implementations.goml Update rustdoc GUI tests to new browser-ui-test version 2023-04-11 19:14:35 +02:00
tooltip-over-sidebar.goml rustdoc ui: adjust tooltip z-index to be above sidebar 2023-12-31 20:31:56 +01:00
tooltips.goml Add GUI regression test for tooltips i icons 2025-08-04 19:17:08 +02: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-alias.goml Fix invalid link generation for type alias methods 2025-11-24 17:01:32 +01:00
type-declation-overflow.goml rustdoc-search: search backend with partitioned suffix tree 2025-08-15 10:26:03 -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 Rollup merge of #151091 - hide-deprecated-items, r=lolbinarycat 2026-01-20 18:00:09 +11: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.