Commit graph

83 commits

Author SHA1 Message Date
Guillaume Gomez
10165f8af9
Rollup merge of #88093 - Kobzol:rustdoc-wrap-code-in-code-tag, r=GuillaumeGomez
[rustdoc] Wrap code blocks in <code> tag

This PR modifies Rustdoc output so that fenced code snippets, items and whole file source codes are wrapped in `<pre><code>` instead of just `<pre>`. This should improve the semantic meaning of the generated content.

I'm not sure what to do about `render_attributes_in_pre` and `render_attributes_in_code`. These functions were clearly expected to be used for things inside `<pre>` or `<code>`, and since I added `<code>` in this PR, some of them will be used in a different context than before. However, it seems to me that even before they were not consistent. For example, `item_constant` used `render_attributes_in_code` for its attributes, however there was no `<code>` used for constants before this PR...

Should I create some `rustdoc-gui` tests? For example to check that all `<pre>` tags have a `<code>` child?

Fixes: https://github.com/rust-lang/rust/issues/88020
2021-08-19 19:30:09 +02:00
Jakub Beránek
ccd550ee56
[rustdoc] Wrap code blocks in <code> tag 2021-08-19 10:30:08 +02:00
Stefan Schindler
2f486d5f8d Merge the two test files as they are testing the same features 2021-08-16 21:50:13 +02:00
Stefan Schindler
ee4521e19b Add a font test based on #85669 2021-08-16 21:50:12 +02:00
Guillaume Gomez
a3d3df4ba6 Add rustdoc GUI test for headers 2021-08-13 14:23:13 +02:00
bors
5782f01a51 Auto merge of #87390 - notriddle:notriddle/rustdoc-headers-patch, r=GuillaumeGomez
Rustdoc accessibility: use real headers for doc items

Part of #87059

Partially reverts #84703

Preview at: https://notriddle.com/notriddle-rustdoc-test/real-headers/std/index.html
2021-07-25 21:41:57 +00:00
bors
76a3b609d0 Rustdoc accessibility: use real headers for doc items
Part of #87059

Partially reverts #84703

Preview at: https://notriddle.com/notriddle-rustdoc-test/real-headers/std/index.html
2021-07-25 21:41:57 +00:00
Yuki Okushi
57ea2d8bb1
Rollup merge of #87398 - GuillaumeGomez:test-font-module-items, r=notriddle
Add test for fonts used for module items

Fixes #85632.

r? `@notriddle`
2021-07-24 04:31:14 +09:00
Guillaume Gomez
327eef999e Add test for fonts used for module items 2021-07-23 11:41:21 +02:00
Guillaume Gomez
8dba89823a
Rollup merge of #87288 - ijackson:rustdoc-theme, r=GuillaumeGomez
rustdoc: Restore --default-theme, etc, by restoring varname escaping

In #86157

    cd0f93193c
    Use Tera templates for rustdoc.

dropped the following transformation from the keys of the default settings element's `data-` attribute names:

    .map(|(k, v)| format!(r#" data-{}="{}""#, k.replace('-', "_"), Escape(v)))

The `Escape` part is indeed no longer needed, because Tera does that for us.  But the massaging of `-` to `_` is needed, for the (bizarre) reasons explained in the new comments.

I have tested that the default theme function works again for me.  I have also verified that passing (in shell syntax)

    '--default-theme="zork&"'

escapes the value in the HTML.

Closes #87263
2021-07-22 13:39:22 +02:00
Guillaume Gomez
df6bdd764a Move implementors directly into lib2 2021-07-22 12:58:59 +02:00
Guillaume Gomez
174728d045 Add tests for default-settings 2021-07-22 12:58:59 +02:00
Guillaume Gomez
3bafcf87aa Remove cargo workspace to build rustdoc-gui test crates because of cargo config not being applied 2021-07-21 20:07:50 +02:00
Guillaume Gomez
de25b1c740 Add test to ensure tables are not inside items summary 2021-07-21 20:06:06 +02:00
Guillaume Gomez
e6380a699b
Rollup merge of #87230 - GuillaumeGomez:docblock-table-overflow, r=notriddle
Fix docblock <table> overflow

Before:

![Screenshot from 2021-07-18 00-05-23](https://user-images.githubusercontent.com/3050060/126050272-ce08bc5f-74ff-4135-bc12-d708d87470cc.png)

After:

![Screenshot from 2021-07-18 00-03-55](https://user-images.githubusercontent.com/3050060/126050273-42f41b4d-ad57-4a87-91de-18e63f8504ec.png)

cc `@SergioBenitez`

r? `@notriddle`
2021-07-21 15:52:46 +02:00
Guillaume Gomez
8cf995f6ac
Rollup merge of #87251 - GuillaumeGomez:item-info-width, r=notriddle
Fix "item info" width

Fixes #87202.

It now looks again like this:

![Screenshot from 2021-07-18 12-33-27](https://user-images.githubusercontent.com/3050060/126064005-013acabc-7f17-4436-8dfc-cb6b9bc24413.png)

cc `@jyn514`

r? `@notriddle`
2021-07-19 11:37:46 +02:00
Guillaume Gomez
57f7501b1d Add test to check width of item-info 2021-07-18 12:32:26 +02:00
Guillaume Gomez
3f1a120ba9 Add GUI test for <table> overflow 2021-07-18 00:03:30 +02:00
Guillaume Gomez
b0f8776d11 Remove unused file 2021-07-18 00:03:30 +02:00
Michael Howell
1941764607 Fix sidebar-mobile test to focus on an actual focusable element 2021-07-17 11:53:59 -07:00
Guillaume Gomez
e596aa294b
Rollup merge of #87188 - GuillaumeGomez:gui-test-auto-hide-trait-impl, r=notriddle
Add GUI test for auto-hide-trait-implementations setting

Fixes #85592.

r? ``@notriddle``
2021-07-16 19:54:10 +02:00
Guillaume Gomez
12ed22ffe4
Rollup merge of #87180 - notriddle:notriddle/sidebar-keyboard-mobile, r=GuillaumeGomez
feat(rustdoc): open sidebar menu when links inside it are focused

Fixes #87172

Based on #87167 (which should be merged first)

r? ``@GuillaumeGomez``

Preview it at https://notriddle.com/notriddle-rustdoc-test/std/index.html
2021-07-16 19:54:08 +02:00
Michael Howell
0ea2980ae5 feat(rustdoc): open sidebar menu when links inside it are focused
Fixes #87172

Based on #87167 (which should be merged first)

Preview it at https://notriddle.com/notriddle-rustdoc-test/std/index.html

Co-authored-by: Guillaume Gomez <guillaume.gomez@huawei.com>
2021-07-16 08:32:20 -07:00
Guillaume Gomez
f6efa33566 Add GUI test for auto-hide-trait-implementations setting 2021-07-16 15:15:23 +02:00
Guillaume Gomez
b19f37ca54
Rollup merge of #87167 - GuillaumeGomez:sidebar-display-mobile, r=notriddle
Fix sidebar display on small devices

Part of #87059.

Instead of hiding the sidebar on small devices, we instead move it out of the viewport so that it remains "visible" to our text only users.

Could you confirm it works for you `@ahicks92` and `@DataTriny` please? You can give it a try at [this URL](https://guillaume-gomez.fr/rustdoc-test/test_docs/index.html).

r? `@notriddle`
2021-07-16 10:08:11 +02:00
Guillaume Gomez
868ffd03ed Add test for sidebar display value on mobile 2021-07-15 22:21:33 +02:00
Guillaume Gomez
25e74037e8 Add regression test for type declaration layout overflow 2021-07-15 18:19:25 +02:00
Guillaume Gomez
e0d72d0f92
Rollup merge of #87125 - GuillaumeGomez:ayu-code-color, r=notriddle
Fix Ayu theme <code> color

Fixes #87072 (the second regression).

r? `@notriddle`
2021-07-14 19:53:40 +02:00
Guillaume Gomez
57e021c941
Rollup merge of #87056 - GuillaumeGomez:fix-codeblocks-overflow, r=notriddle
Fix codeblocks overflow

Fixes #87043.

Instead of completely relying on `pulldown-cmark` (and its potential changes), I decided to move the generation of codeblocks HTML directly in rustdoc so we can unify the DOM and the CSS classes.

r? `@Nemo157`
2021-07-14 19:53:36 +02:00
Guillaume Gomez
46b4b377b8 Add GUI test to check ayu <code> colors 2021-07-14 15:00:12 +02:00
Guillaume Gomez
7593bfe1aa Add test for codeblocks overflow 2021-07-14 12:03:55 +02:00
Yuki Okushi
afaca5ba79
Rollup merge of #87102 - GuillaumeGomez:go-to-first-feature, r=Manisheart,notriddle
Add GUI test for "go to first" feature

It adds a test for #85876 to ensure the feature is working as expected and prevent potential regression.

cc ```@jeanlucthumm```

r? ```@Manishearth```
2021-07-14 09:35:27 +09:00
Guillaume Gomez
cac0d71b6a Add test for "go to first" feature 2021-07-13 19:41:58 +02:00
Guillaume Gomez
b8264a862f Add test for keyword/primitive text color 2021-07-13 10:18:24 +02:00
Guillaume Gomez
f0169e923b Add test for search results colors 2021-07-13 10:18:23 +02:00
Guillaume Gomez
bd819493d7 Add test for implementors 2021-07-12 19:03:59 +02:00
Guillaume Gomez
da6d82e465 Simplify build system for rustdoc-gui test crates 2021-07-12 19:03:59 +02:00
Stefan Schindler
3645851087 Enable the tests developed with #86594 2021-07-01 10:13:28 +02:00
bors
5d34076975 Auto merge of #86650 - GuillaumeGomez:fix-boldness, r=Nemo157
Fix boldness (put it back where needed)

I realized that I created a GUI test that wasn't run because it had ".rs" extension instead of ".goml" so I moved its content into `font-weight.goml` (since it was checking font weight).
2021-06-30 10:54:08 +00:00
Stefan Schindler
0f2e137353 Add test for item-table with resize to mobile 2021-06-28 21:46:05 +02:00
Guillaume Gomez
2fd1229a1a Add tests to ensure the font-weight is the correct one 2021-06-26 21:38:24 +02:00
Guillaume Gomez
7a5837c810 Remove erroneously created file 2021-06-26 21:38:04 +02:00
Stefan Schindler
e2efcf10de Fixing the test rustdoc by ignoring *[@id="module-item"]//following-sibling::item-right relationship and rustdoc-gui 2021-06-24 16:46:15 +02:00
Guillaume Gomez
c4023c6ca3 Fix search filter update 2021-06-23 10:09:26 +02:00
Dylan DPC
f19aad85a8
Rollup merge of #86542 - GuillaumeGomez:line-numbers-aligned-with-content, r=jyn514
Line numbers aligned with content

We had the issue a few times in the past where the source code pages' content wasn't aligned with the line numbers but completely below. This test will prevent this change to go unnoticed.

The first commit comes from https://github.com/rust-lang/rust/pull/86541 so it needs it to be merged first.

r? `@jsha`
2021-06-23 00:20:22 +02:00
Guillaume Gomez
5c9e10eec3 Add check to ensure that the line numbers are aligned with the source code 2021-06-22 11:17:53 +02:00
Guillaume Gomez
3af9c9157e Update browser-ui-test version 2021-06-22 11:11:45 +02:00
Yuki Okushi
7dca2e276d
Rollup merge of #86297 - GuillaumeGomez:rustdoc-gui-args, r=Mark-Simulacrum
Allow to pass arguments to rustdoc-gui tool

Very convenient for testing. This is another part of https://github.com/rust-lang/rust/pull/86293

cc ``@jsha``
r? ``@Mark-Simulacrum``
2021-06-22 07:37:48 +09:00
Guillaume Gomez
1e222ba58a Update browser-ui-test version 2021-06-19 14:19:39 +02:00
Jacob Hoffman-Andrews
5de1391b88 Factor out render_rightside
This covers rendering of stability_since and the srclink across methods
and trait implementations, so their DOM representation is consistent.
2021-06-16 22:46:53 -07:00