Guillaume Gomez
30734c4e68
Fix deduplication of items
2017-12-01 20:55:25 +01:00
Guillaume Gomez
0a1219809d
Fix global search
2017-11-26 13:13:14 +01:00
bors
ca8ef26293
Auto merge of #46081 - GuillaumeGomez:fix-path-search, r=QuietMisdreavus
...
Fix path search
Fixes #46015 .
r? @QuietMisdreavus
2017-11-25 02:43:48 +00:00
bors
421a2113a8
Auto merge of #45039 - QuietMisdreavus:doc-spotlight, r=GuillaumeGomez,QuietMisdreavus
...
show in docs whether the return type of a function impls Iterator/Read/Write
Closes #25928
This PR makes it so that when rustdoc documents a function, it checks the return type to see whether it implements a handful of specific traits. If so, it will print the impl and any associated types. Rather than doing this via a whitelist within rustdoc, i chose to do this by a new `#[doc]` attribute parameter, so things like `Future` could tap into this if desired.
### Known shortcomings
~~The printing of impls currently uses the `where` class over the whole thing to shrink the font size relative to the function definition itself. Naturally, when the impl has a where clause of its own, it gets shrunken even further:~~ (This is no longer a problem because the design changed and rendered this concern moot.)
The lookup currently just looks at the top-level type, not looking inside things like Result or Option, which renders the spotlights on Read/Write a little less useful:
<details><summary>`File::{open, create}` don't have spotlight info (pic of old design)</summary>
</details>
All three of the initially spotlighted traits are generically implemented on `&mut` references. Rustdoc currently treats a `&mut T` reference-to-a-generic as an impl on the reference primitive itself. `&mut Self` counts as a generic in the eyes of rustdoc. All this combines to create this lovely scene on `Iterator::by_ref`:
<details><summary>`Iterator::by_ref` spotlights Iterator, Read, and Write (pic of old design)</summary>
</details>
2017-11-21 03:03:28 +00:00
Guillaume Gomez
c00eaa9969
Strongly improve search path
2017-11-20 21:54:27 +01:00
Guillaume Gomez
ad6324f6f7
Fix path search in docs
2017-11-19 12:14:56 +01:00
Guillaume Gomez
6047a03659
Add tooltip for important traits display
2017-11-18 14:37:10 +01:00
bors
18250b0349
Auto merge of #46073 - GuillaumeGomez:rollup, r=GuillaumeGomez
...
Rollup of 4 pull requests
- Successful merges: #45767 , #46044 , #46066 , #46071
- Failed merges:
2017-11-18 11:38:06 +00:00
Guillaume Gomez
d86621f69e
Add trait methods as well
2017-11-17 22:50:15 +01:00
Guillaume Gomez
85dcf2ecb6
Improve modal display and add JS events
2017-11-17 22:50:15 +01:00
Guillaume Gomez
aca1bd7d7e
First step for important traits UI
2017-11-17 22:50:15 +01:00
QuietMisdreavus
cbe4ac3079
spotlight Iterator/Read/Write impls on function return types
2017-11-17 22:50:15 +01:00
Guillaume Gomez
955c054ab1
Fix primitive types not showing up
2017-11-17 22:33:02 +01:00
kennytm
2792b56a92
Support extern type in rustdoc.
...
Fixes #45640 .
2017-11-15 18:20:28 +08:00
Guillaume Gomez
0e4c829f2b
Add "As parameters" items as well
2017-11-12 21:38:24 +01:00
Guillaume Gomez
5c5ab0d1fb
Improve result output
2017-11-12 21:38:24 +01:00
Guillaume Gomez
6514f44bd1
Big JS optimization
2017-11-12 21:38:23 +01:00
Guillaume Gomez
c96be6f4cb
Add elements count in tab search title
2017-11-12 21:38:23 +01:00
Guillaume Gomez
c3207ba0cf
JS big updates
2017-11-12 21:38:23 +01:00
Guillaume Gomez
fec24adea8
Rollup merge of #45812 - GuillaumeGomez:links-and-search, r=QuietMisdreavus
...
Fix navbar click while in a search
Fixes #45790 .
2017-11-11 13:38:06 +01:00
Guillaume Gomez
0d898998b1
Few improvements on search, history and title
2017-11-11 00:44:36 +01:00
Guillaume Gomez
72338b8ccb
Allow to go back to previous search
2017-11-10 19:40:46 +01:00
Guillaume Gomez
5e116985eb
Add "-" shortcut
2017-11-07 22:44:18 +01:00
Guillaume Gomez
acd5e8cd4e
Fix navbar click while in a search
2017-11-06 23:49:47 +01:00
Guillaume Gomez
ee7e372bbf
Remove duplicated results in the search
2017-11-01 13:41:43 +01:00
Guillaume Gomez
e8db5adcce
fix function not appearing in first tab when appearing in another one. Thanks to @Seeker14491 for this one!
2017-11-01 13:41:43 +01:00
Guillaume Gomez
f6a546e14d
Be more flexible when looking for something by using levenshtein method
2017-11-01 13:41:43 +01:00
Guillaume Gomez
6f21008aba
Better check for returned value
2017-11-01 13:41:43 +01:00
Guillaume Gomez
56dbb3e32d
Keep displaying good information when query is made
2017-11-01 13:41:43 +01:00
kennytm
07df45d363
Rollup merge of #45450 - GuillaumeGomez:overlap-link, r=QuietMisdreavus
...
Fix title heading overlap in rust doc
Fixes #45158 .
To be noted that this margin only appears when a title is the first element.
<img width="1440" alt="screen shot 2017-10-22 at 16 08 44" src="https://user-images.githubusercontent.com/3050060/31862746-6411070e-b743-11e7-9a75-4159e1f7f1d6.png ">
r? @rust-lang/docs
2017-11-01 13:32:08 +08:00
Guillaume Gomez
8fb1250aba
Improve sidebar rendering and add methods list
2017-10-27 23:09:18 +02:00
kennytm
fc48893845
Rollup merge of #45212 - GuillaumeGomez:sidebar-fixed, r=QuietMisdreavus
...
Limit the sidebar height
The sidebar is now fixed, which means its scrolling is independent of the main page now.
r? @rust-lang/docs
2017-10-26 03:02:49 +08:00
Guillaume Gomez
deef11dd26
Show src button and function version on mobile version
2017-10-24 22:34:59 +02:00
Guillaume Gomez
9ce41f2544
Fix the sidebar height
2017-10-24 21:16:43 +02:00
Guillaume Gomez
237ad82f3c
Remove useless top margin on first heading
2017-10-22 16:11:07 +02:00
Guillaume Gomez
becd45be80
Fix title heading overlap in rust doc
2017-10-22 16:08:31 +02:00
bors
a651106ad0
Auto merge of #45288 - GuillaumeGomez:tab-key-binding, r=QuietMisdreavus
...
Save the highlighted item when switching tab
To be merged after #45281 .
r? @rust-lang/docs
2017-10-19 23:55:20 +00:00
kennytm
4913b92ff5
Rollup merge of #45281 - GuillaumeGomez:tab-selection, r=QuietMisdreavus
...
Save selected search tab
Fixes #45278 .
r? @rust-lang/docs
2017-10-19 01:59:50 +08:00
bors
0be6863a15
Auto merge of #45290 - GuillaumeGomez:fix-help, r=QuietMisdreavus
...
Hide help when search bar is focused
Fixes #45286
r? @rust-lang/docs
2017-10-17 12:18:25 +00:00
Guillaume Gomez
c6ce067216
Hide help when search bar is focused
2017-10-14 18:46:29 +02:00
Guillaume Gomez
f44232688e
Save current highlighted item in search tab
2017-10-14 18:24:27 +02:00
Guillaume Gomez
45bb03f60c
Save selected search tab
2017-10-14 18:15:20 +02:00
Guillaume Gomez
c729e4dca7
Remove terribly useless and problematic margin when searching on mobile
2017-10-14 15:55:33 +02:00
kennytm
fb98e3e434
Rollup merge of #45245 - stjepang:more-padding-between-impls, r=QuietMisdreavus
...
Rustdoc: Increase padding between consecutive impls
Currently, [implementors](https://doc.rust-lang.org/nightly/std/iter/trait.IntoIterator.html#implementors ) list is a bit too condensed. More spacing makes the list easier to read.
Check out [this comment](https://github.com/rust-lang/rust/issues/41879#issuecomment-333121118 ) to see what's the effect of this change.
Closes #41879 .
cc @QuietMisdreavus
2017-10-13 23:38:04 +08:00
kennytm
f43c54e1e3
Rollup merge of #45240 - GuillaumeGomez:mobile-sidebar-improvements, r=QuietMisdreavus
...
Mobile sidebar improvements
Very small changes, I just made the width of the sidebar of 100% and centered vertically both items a bit more:
<img width="1440" alt="screen shot 2017-10-12 at 20 00 47" src="https://user-images.githubusercontent.com/3050060/31511496-302bb474-af88-11e7-8dab-2c88799eafcc.png ">
r? @rust-lang/docs
2017-10-13 23:38:03 +08:00
bors
d21c023964
Auto merge of #45055 - GuillaumeGomez:search-tabs, r=QuietMisdreavus
...
Add tabs for search for better information access
A few screenshots:
<img width="1440" alt="screen shot 2017-10-06 at 00 54 51" src="https://user-images.githubusercontent.com/3050060/31256148-032c1a06-aa31-11e7-8e4c-fec59786b8e6.png ">
<img width="1440" alt="screen shot 2017-10-06 at 00 54 58" src="https://user-images.githubusercontent.com/3050060/31256150-03312cb2-aa31-11e7-86f7-8c9f0d8d6d4f.png ">
<img width="1440" alt="screen shot 2017-10-06 at 00 55 00" src="https://user-images.githubusercontent.com/3050060/31256149-0330d456-aa31-11e7-8f89-3b3c824e30b4.png ">
r? @rust-lang/docs
cc @killercup @QuietMisdreavus
2017-10-13 11:34:11 +00:00
Stjepan Glavina
16ec7b949f
Increase padding between consecutive impls
2017-10-12 22:57:51 +02:00
Guillaume Gomez
9da9c3be62
Small improvement for the sidebar on mobile devices
2017-10-12 20:02:29 +02:00
Guillaume Gomez
3a65d12df7
Add tabs for search for better information access
...
Make tabs work
2017-10-09 23:26:10 +02:00
QuietMisdreavus
fcee950660
let rustdoc print the crate version into docs
2017-10-09 09:56:17 -05:00
