Matthias Krüger
deee6f770f
Rollup merge of #92830 - jsha:style-cleanups, r=GuillaumeGomez
...
Rustdoc style cleanups
- Make "since" version numbers grey again (regressed in #92602 ).
- Remove unneeded selectors for when crate filter dropdown is a
sibling of search-input.
- Crate filter dropdown doesn't need to be 100% width on mobile.
- Only build crate filter dropdown when there is more than one crate.
- Remove unused addCrateDropdown
Demo: https://rustdoc.crud.net/jsha/style-cleanups/std/string/struct.String.html
r? `@GuillaumeGomez`
2022-01-18 04:42:02 +01:00
Matthias Krüger
cc2339ce83
Rollup merge of #92803 - jsha:hide-sidebar, r=GuillaumeGomez
...
Hide mobile sidebar on some clicks
When the user clicks outside the sidebar, the sidebar should close. Also, when the user clicks an internal link in the sidebar, it should close.
Fixes #92682
Demo: https://rustdoc.crud.net/jsha/hide-sidebar/std/string/struct.String.html
2022-01-18 04:42:00 +01:00
Matthias Krüger
d501ead009
Rollup merge of #92629 - jsha:theme-picker-local-only-2, r=GuillaumeGomez
...
Pick themes on settings page, not every page
This hides the paintbrush icon on most pages by default, in preference for the settings on the settings page. When loading from a local file, and not in mobile view, continue to show the theme picker. That's because some browsers limit access to localStorage from file:/// URLs, so choosing a theme from settings.html doesn't take effect.
Fixes #84539
Part of #59840
r? `@GuillaumeGomez`
Demo: https://rustdoc.crud.net/jsha/theme-picker-local-only-2/std/io/trait.Read.html
2022-01-18 04:41:58 +01:00
Jacob Hoffman-Andrews
ae99e23c11
Add staged_api for tests
2022-01-17 13:23:46 -08:00
Jacob Hoffman-Andrews
b71f1fb002
Hide mobile sidebar on some clicks
...
When the user clicks outside the sidebar, the sidebar should close.
Also, when the user clicks an internal link in the sidebar, it should
close.
2022-01-17 12:01:35 -08:00
Jacob Hoffman-Andrews
04f04026c5
Add support for "always theme" in setting
2022-01-14 19:33:37 -08:00
Jacob Hoffman-Andrews
7781636fc7
Link sidebar "location" heading to top of page
...
This makes it easy, when you are scrolled far down in a page, to jump
back to the top.
2022-01-14 10:41:30 -08:00
Matthias Krüger
05dd1e4a2b
Rollup merge of #92764 - GuillaumeGomez:fix-rust-logo-style, r=jsha
...
Fix rust logo style
The style on the rust logo is currently broken:
With this fix, we're back to normal:
I also used a GUI test to prevent future silent regressions.
r? ```@jsha```
2022-01-12 07:12:19 +01:00
Guillaume Gomez
24c6e963d0
Add GUI test for rust logo style in the sidebars
2022-01-11 13:57:17 +01:00
Matthias Krüger
a4ac4fae41
Rollup merge of #92602 - jsha:source-link-2, r=GuillaumeGomez
...
Make source links look cleaner
Change from syntaxy-looking [src] to the plain word "source".
Change the syntaxy-looking `[-]` at the top of the page to say "collapse".
Reduce opacity of rightside content.
Part of #59851
r? `@GuillaumeGomez`
Demo: https://rustdoc.crud.net/jsha/source-link-2/std/string/struct.String.html
[Discussed on Zulip](https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/display.20of.20source.20link ).
2022-01-10 11:03:06 +01:00
Matthias Krüger
598364c995
Rollup merge of #92490 - jsha:crates-in-results, r=GuillaumeGomez
...
Move crate drop-down to search results page
This reduces clutter on doc pages.
Part of #59840
r? ```@GuillaumeGomez```
Demo: https://rustdoc.crud.net/jsha/crates-in-results/std/index.html?search=str
2022-01-09 13:38:29 +01:00
Jacob Hoffman-Andrews
962c0a4ee5
Make source links look cleaner
...
Change from syntaxy-looking [src] to the plain word "source".
2022-01-08 09:49:41 -05:00
Matthias Krüger
b510278278
Rollup merge of #92404 - GuillaumeGomez:src-font-size, r=jsha
...
Fix font size for [src] links in headers
Fixes #90384 .
cc `@jsha`
r? `@camelid`
2022-01-06 12:01:04 +01:00
Matthias Krüger
50d5e38800
Rollup merge of #92058 - jsha:run-on-hover, r=GuillaumeGomez
...
Make Run button visible on hover
This slightly reduces the noisiness of doc pages, making them easier to read.
Demo: https://rustdoc.crud.net/jsha/run-on-hover/std/string/struct.String.html
[Discussed on Zulip](https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/.22Run.22.20button.20visible.20on.20hover ).
Part of #59845
2022-01-06 12:00:59 +01:00
Jacob Hoffman-Andrews
8abb4bb698
Move crate drop-down to search results page
...
This reduces clutter on doc pages.
2022-01-05 12:57:25 -05:00
Guillaume Gomez
a0085f249a
Add test for [src] font-size in headers
2022-01-05 17:35:06 +01:00
Jacob Hoffman-Andrews
6409f0d558
Make Run button visible on hover
...
This slightly reduces the noisiness of doc pages, making them easier to
read.
2022-01-05 10:07:22 -05:00
Matthias Krüger
2da54c729e
Rollup merge of #92440 - GuillaumeGomez:fix-mobile-toggles, r=jsha
...
Fix mobile toggles position
Before:
After:
r? `@jsha`
2021-12-31 23:14:49 +01:00
Matthias Krüger
72e36d47e8
Rollup merge of #91480 - jsha:fewer-colors, r=GuillaumeGomez
...
rustdoc: use smaller number of colors to distinguish items
This reduces visual distractions when reading method signatures.
As discussed in https://github.com/rust-lang/rust/issues/59845#issuecomment-974757191 , this categorizes items into one of six colors (down from thirteen):
- method, function (ochre `#AD7C37`)
- trait, trait alias (dark slate blue `#6E4FC9`)
- enum, struct, type alias, union, primitive (maroon `#AD378A`)
- static, module, keyword, associated type, foreign type (steel blue `#3873AD`)
- macro (green `#068000`)
- generic params, self, Self (unmarked black `#000000`)
I slightly tweaked the actual color values so they'd have the same lightness (previously the trait color stood out much more than the others). And I made the color for links in general consistently use steel blue (previously there was a slightly different color for "search-failed").
The ayu and dark themes have been updated according to the same logic. I haven't changed any of the color values in those themes, just their assignment to types.
Demo:
https://rustdoc.crud.net/jsha/fewer-colors/std/string/struct.String.html
https://rustdoc.crud.net/jsha/fewer-colors/std/vec/struct.Vec.html
https://rustdoc.crud.net/jsha/fewer-colors/std/io/trait.Read.html
https://rustdoc.crud.net/jsha/fewer-colors/std/iter/trait.Iterator.html
2021-12-31 23:14:45 +01:00
Guillaume Gomez
7c78ea5b53
Fix display of toggles on mobile
2021-12-30 16:21:50 +01:00
Matthias Krüger
3f4013d449
Rollup merge of #91834 - GuillaumeGomez:improve-gui-test-readability, r=jsha
...
Update browser-ui-test version and improve rustdoc-gui tests readability
Since the `0.5.1`, we can use trailing commas. I also used the opportunity to clean up the existing tests.
r? `@notriddle`
2021-12-19 00:38:39 +01:00
Matthias Krüger
6132a2b55a
Rollup merge of #91905 - GuillaumeGomez:source-code-page-sidebar, r=jsha
...
Fix source code page sidebar on mobile
Current broken behaviour:
https://user-images.githubusercontent.com/3050060/145984316-35c82353-5bab-4dc6-9ac6-63ea7e5c27d8.mp4
Fixed:
https://user-images.githubusercontent.com/3050060/145984329-8be1127b-d707-424d-ac3c-c1fb3c48a093.mp4
r? `@jsha`
2021-12-15 08:36:24 +01:00
Guillaume Gomez
0919d0077a
Add GUI test for source code page sidebar
2021-12-14 11:50:41 +01:00
Guillaume Gomez
632508698a
Update browser-ui-test version and improve rustdoc-gui tests readability
2021-12-12 18:28:58 +01:00
Jacob Hoffman-Andrews
3f517fb1ae
Split CSS classes for "typedef" vs "associatedtype".
2021-12-10 22:25:43 -08:00
Matthias Krüger
d748c1ddbb
Rollup merge of #91534 - jsha:heading-color, r=GuillaumeGomez
...
Make rustdoc headings black, and markdown blue
Demo:
https://rustdoc.crud.net/jsha/heading-color/std/string/index.html#structs
https://rustdoc.crud.net/jsha/heading-color/std/string/struct.String.html#examples
Fixes #91304
r? ```@camelid``` /cc ```@GuillaumeGomez```
(Note: we may want to make rustdoc headings and markdown headings the same color -- #90245 -- but we would want to do that intentionally; this is fixing up a change that did so accidentally)
2021-12-08 23:18:05 +01:00
Jacob Hoffman-Andrews
e1ff02bb81
Make rustdoc headings black, and markdown blue
2021-12-04 19:56:09 -08:00
Jacob Hoffman-Andrews
2a7ee2178b
Use fewer colors in rustdoc UI
...
This reduces visual distractions when reading method signatures.
2021-12-03 16:34:29 -08:00
Guillaume Gomez
d7e998dd14
Rename ID "main" into "main-content"
2021-12-02 14:17:20 +01:00
Guillaume Gomez
1e55c31cbb
Fix remaining bugs
2021-12-02 14:17:20 +01:00
cynecx
e2467f2c45
rustdoc: fix source-code-page test
2021-11-29 11:07:20 +01:00
Guillaume Gomez
23427567b2
Update test for anchors and headings position
2021-11-26 21:03:45 +01:00
Guillaume Gomez
e340478f5d
Improve tests
2021-11-25 14:49:03 +01:00
bors
d2c24aabcd
Auto merge of #91203 - GuillaumeGomez:rollup-kwtqvb1, r=GuillaumeGomez
...
Rollup of 7 pull requests
Successful merges:
- #89542 (Partially stabilize `duration_consts_2`)
- #90044 (Restrict aarch64 outline atomics to glibc for now.)
- #90420 (Create rustdoc_internals feature gate)
- #91075 (Reduce prominence of item-infos)
- #91151 (Fix test in std::process on android)
- #91179 (Fix more <a> color)
- #91199 (rustdoc: Add test for mixing doc comments and attrs)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
2021-11-24 23:09:42 +00:00
Guillaume Gomez
3bc8fc8049
Rollup merge of #91179 - GuillaumeGomez:a-color, r=jsha
...
Fix more <a> color
Fixes #91175 .
Another bug I saw is:
I fixed it as well.
r? ``@jsha``
2021-11-24 22:56:39 +01:00
Guillaume Gomez
9390b50ef4
Rollup merge of #91075 - jsha:chill-item-info, r=GuillaumeGomez
...
Reduce prominence of item-infos
Fixes #59853
- Remove border.
- Reduce size of emoji slightly.
- Remove details disclosure for unstable reason. This was inconsistent with our other details disclosures, and the detail revealed was usually better explained by clicking on the issue link.
Demo: https://rustdoc.crud.net/jsha/chill-item-info/std/mem/union.MaybeUninit.html#method.slice_assume_init_ref
Compare vs: https://doc.rust-lang.org/nightly/std/mem/union.MaybeUninit.html#method.slice_assume_init_ref
<img src="https://user-images.githubusercontent.com/220205/142717815-09828c9e-6ff4-445a-8ccc-31e028fd4985.png " width=700>
2021-11-24 22:56:37 +01:00
Guillaume Gomez
a6a1d7ca29
Rollup merge of #90420 - GuillaumeGomez:rustdoc-internals-feature, r=camelid
...
Create rustdoc_internals feature gate
As suggested by ``@camelid`` [here](https://github.com/rust-lang/rust/pull/90398#issuecomment-955093851 ), since `doc_keyword` and `doc_primitive` aren't meant to be stabilized, we could put them behind a same feature flag.
This is pretty much what it would look like (needs to update the tests too).
The tracking issue is https://github.com/rust-lang/rust/issues/90418 .
What do you think ``@rust-lang/rustdoc`` ?
2021-11-24 22:56:37 +01:00
Guillaume Gomez
1e6ced3532
Create rustdoc_internals feature gate
2021-11-24 21:57:18 +01:00
Jacob Hoffman-Andrews
04cb0dc8a9
Fix clicking on anchors inside summary tags.
2021-11-24 10:46:55 -08:00
Guillaume Gomez
0ba92fe5a3
Update GUI tests for <a> color
2021-11-24 14:27:05 +01:00
bors
982c552c90
Auto merge of #91171 - jsha:fix-rustdoc-gui-test, r=GuillaumeGomez
...
Fix toggle-click-deadspace rustdoc-gui test
In #91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at https://github.com/rust-lang/rust/pull/91062#issuecomment-977589705 and https://github.com/rust-lang/rust/pull/91170#issuecomment-977636159 .
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
2021-11-24 09:43:47 +00:00
Jacob Hoffman-Andrews
420be4a282
Fix toggle-click-deadspace rustdoc-gui test
2021-11-24 00:58:07 -08:00
Matthias Krüger
eb5c2d3895
Rollup merge of #91103 - jsha:non-toggle-click-doesnt-toggle, r=Manishearth,GuillaumeGomez
...
Inhibit clicks on summary's children
A byproduct of using `<details>` and `<summary>` to show/hide detailed documentation was that clicking any part of a method heading (or impl heading) would show or hide the documentation. This was not super noticeable because clicking a link inside the method heading would navigate to that link. But clicking any unlinked black text in a method heading would trigger the behavior.
That behavior was somewhat unexpected, and means that if you try to click a type name in a method heading, but miss by a few pixels, you get a confusing surprise.
This change inhibits that behavior by putting an event listener on most summaries that cancels the event unless the event target was the summary itself. In practice, that means it cancels the event unless the target was the "[+]" / "[-]", because the rest of the heading is wrapped inside a `<div>`, which is the target for anything that doesn't have a more specific target.
r? ``@Manishearth``
2021-11-23 19:28:07 +01:00
Matthias Krüger
cb7776758c
Rollup merge of #91102 - jsha:theme-anchor, r=GuillaumeGomez
...
Set color for <a> in a more straightforward way.
Previously, we set the default color for <a> tags to black, and then had an override with a bunch of not() clauses to set anchors in
docblocks to blue.
Instead, we should set the default color for <a> to blue (or equivalent in other themes), and override it for places like the sidebar or search results, where we don't want them to be styled as links.
Demo at https://rustdoc.crud.net/jsha/theme-anchor/std/string/struct.String.html . This should result in no visible changes.
r? `@GuillaumeGomez`
2021-11-22 23:30:29 +01:00
Jacob Hoffman-Andrews
7f35556a25
Add GUI test for clicking on non-toggle summary
2021-11-22 01:17:20 -08:00
Jacob Hoffman-Andrews
a56559df13
Set color for <a> in a more straightforward way
...
Previously, we set the default color for <a> tags to black, and then
had an override with a bunch of not() clauses to set anchors in
docblocks to blue.
Instead, we should set the default color for <a> to blue (or equivalent
in other themes), and override it for places like the sidebar or search
results, where we don't want them to be styled as links.
2021-11-22 01:13:27 -08:00
Jacob Hoffman-Andrews
e6ab982d46
Reduce prominence of item-infos
...
- Remove border.
- Reduce size of emoji slightly.
- Remove details disclosure for unstable reason. This was inconsistent
with our other details disclosures, and the detail revealed was
usually better explained by clicking on the issue link.
2021-11-20 00:10:22 -08:00
Matthias Krüger
c0695bbf60
Rollup merge of #90089 - jsha:enum-fields-headings, r=camelid,GuillaumeGomez
...
Improve display of enum variants
Use h3 and h4 for the variant name and the "Fields" subheading.
Remove the "of T" part of the "Fields" subheading.
Remove border-bottom from "Fields" subheading.
Move docblock below "Fields" listing.
Fixes #90061
Demo:
https://jacob.hoffman-andrews.com/rust/xmlparser-updated/xmlparser/enum.Token.html#variants
https://jacob.hoffman-andrews.com/rust/fix-enum-variants/std/io/enum.ErrorKind.html#variants
https://jacob.hoffman-andrews.com/rust/fix-enum-variants/std/result/enum.Result.html#variants
r? ``@camelid``
2021-11-20 01:09:38 +01:00
Guillaume Gomez
aa17e1c47f
Fix missing bottom border for headings in sidebar
2021-11-04 20:07:24 +01:00
Jacob Hoffman-Andrews
a4fe76ff7c
Hide search bar in noscript.css
...
Also, remove the highlighting of the search bar in disabled state. This
reduces flicker when loading a page.
2021-10-31 12:41:06 -07:00
