Guillaume Gomez
08a741eabf
Add support for image, rules and footnotes
2017-03-29 19:48:06 -06:00
bors
abf5592510
Auto merge of #40338 - GuillaumeGomez:pulldown-switch, r=frewsxcv,steveklabnik
...
Replace hoedown with pull in rustdoc
cc @rust-lang/docs
2017-03-29 07:06:13 +00:00
Guillaume Gomez
a7c6d3e16a
Improve function naming
2017-03-28 11:54:11 -06:00
Guillaume Gomez
286a51da91
Fix id generation
2017-03-28 11:38:56 -06:00
Guillaume Gomez
47e4abf473
Fix plain_summary_line function
2017-03-28 11:38:56 -06:00
Guillaume Gomez
e51f3253be
Handle html in markdown as well
2017-03-28 11:38:55 -06:00
Guillaume Gomez
6a2190c18e
Remove unneeded comment
2017-03-28 11:38:55 -06:00
Guillaume Gomez
6d470a9c4a
Add a macro to improve code
2017-03-28 11:38:55 -06:00
Guillaume Gomez
d5b6c046de
Add missing markdown tags
2017-03-28 11:38:55 -06:00
Guillaume Gomez
b96fef8411
End of pulldown switch and remove completely hoedown
2017-03-28 11:38:55 -06:00
Guillaume Gomez
c9415eb98f
Remains to fix tables
2017-03-28 11:38:55 -06:00
Guillaume Gomez
08a80cbda6
Replace hoedown with pull in rustdoc
2017-03-28 11:38:55 -06:00
Oliver Schneider
eb447f4ef4
Fix various useless derefs and slicings
2017-03-27 08:58:00 +02:00
Corey Farwell
667e3166d8
Rollup merge of #40567 - clarcharr:rustdoc-sort, r=frewsxcv
...
Fix for #39596 : sort Trait2 before Trait10.
This is a change discussed in #39596 . Essentially, item names will be sorted as if they're (&str, u64) pairs instead of just `&str`, meaning that `"Apple" < "Banana"` and also `"Fruit10" > "Fruit2"`.
Sample sorting:
1. Apple
2. Banana
3. Fruit
4. Fruit0
5. Fruit00
6. Fruit1
7. Fruit01
8. Fruit2
9. Fruit02
10. Fruit20
11. Fruit100
12. Pear
Examples of generated documentation:
https://docs.charr.xyz/before-doc/test_sorting/
https://docs.charr.xyz/after-doc/test_sorting/
Screenshots of generated documentation:
Before: http://imgur.com/Ktb10ti
After: http://imgur.com/CZJjqIN
2017-03-24 18:13:09 -05:00
Clar Charr
c09083c3d1
Fix for #39596 : sort Trait1 before Trait2.
2017-03-23 18:21:34 -04:00
Corey Farwell
b2d62e8737
Rollup merge of #40725 - Cldfire:master, r=estebank
...
Remove duplicated styling in main.css
If nothing else, it saves a bit of data.
2017-03-22 19:30:34 -04:00
Cldfire
e2b5a8cf57
Remove duplicate style classes
2017-03-21 23:40:41 -04:00
Guillaume Gomez
f53172287a
Add whitespace around "=" in assoc items
2017-03-21 16:22:15 -04:00
Corey Farwell
d49f86901c
Rollup merge of #40587 - GuillaumeGomez:rustdoc-const-display, r=frewsxcv
...
Fix invalid debug display for associated consts
Fixes #40568 .
r? @rust-lang/docs
cc @SergioBenitez
2017-03-19 20:51:13 -04:00
Corey Farwell
a04c7de2cf
Rollup merge of #40564 - GuillaumeGomez:rustdoc-const, r=frewsxcv
...
Fix const not displayed in rustdoc
Fixes #40331 .
r? @rust-lang/docs
2017-03-19 10:18:15 -04:00
bors
9c15de4fd5
Auto merge of #40346 - jseyfried:path_and_tokenstream_attr, r=nrc
...
`TokenStream`-based attributes, paths in attribute and derive macro invocations
This PR
- refactors `Attribute` to use `Path` and `TokenStream` instead of `MetaItem`.
- supports macro invocation paths for attribute procedural macros.
- e.g. `#[::foo::attr_macro] struct S;`, `#[cfg_attr(all(), foo::attr_macro)] struct S;`
- supports macro invocation paths for derive procedural macros.
- e.g. `#[derive(foo::Bar, super::Baz)] struct S;`
- supports arbitrary tokens as arguments to attribute procedural macros.
- e.g. `#[foo::attr_macro arbitrary + tokens] struct S;`
- supports using arbitrary tokens in "inert attributes" with derive procedural macros.
- e.g. `#[derive(Foo)] struct S(#[inert arbitrary + tokens] i32);`
where `#[proc_macro_derive(Foo, attributes(inert))]`
r? @nrc
2017-03-19 10:56:08 +00:00
Guillaume Gomez
5364acb418
Fix invalid debug display for associated consts
2017-03-17 00:27:36 +01:00
Guillaume Gomez
9b892745ad
Fix const not displayed in rustdoc
2017-03-16 02:15:10 +01:00
Jeffrey Seyfried
68c1cc68b4
Refactor Attribute to use Path and TokenStream instead of MetaItem.
2017-03-14 04:03:43 +00:00
Wesley Wiser
8b9b3b6d8b
Fix sidebar not extending to the bottom of the page
...
Fixes #40459
2017-03-13 20:36:41 -04:00
bors
a5483a7f36
Auto merge of #40451 - ollie27:rustdoc_impls_js_escape, r=GuillaumeGomez
...
rustdoc: Fix string escaping in implementors js files
The generated HTML can contain quotes so we need to make sure they are
escaped before inserting into the js files.
2017-03-13 12:44:22 +00:00
Oliver Middleton
19e0505dc7
rustdoc: Fix string escaping in implementors js files
...
The generates HTML can contain quotes so we need to make sure they are
escaped before inserting into the js files.
2017-03-12 05:12:27 +00:00
Ariel Ben-Yehuda
7b0caa58d9
Rollup merge of #40419 - GuillaumeGomez:fix-const-rendering, r=frewsxcv
...
Fix associated consts display
Fixes #40370 .
r? @frewsxcv
2017-03-11 21:57:49 +02:00
Guillaume Gomez
ea3c82cd96
Fix associated consts display
2017-03-10 16:21:07 +01:00
Guillaume Gomez
4078b25589
Clean up rustdoc css
2017-03-09 19:04:13 +01:00
Wesley Wiser
2bb2a2975f
Improve the style of the sidebar in rustdoc output
...
Makes the sidebar a light grey and highlights the currently viewed item
in the sidebar more prominently.
All visual design credit goes to @johnwhelchel (#37856 )
2017-03-06 18:23:55 -05:00
Corey Farwell
fda3f98746
Rollup merge of #39944 - GuillaumeGomez:associated-consts, r=frewsxcv
...
Improve associated constant rendering in rustdoc
Before:
<img width="1440" alt="screen shot 2017-02-19 at 00 30 51" src="https://cloud.githubusercontent.com/assets/3050060/23097697/caeed80e-f63a-11e6-98c2-5d27e4efd76d.png ">
After:
<img width="1440" alt="screen shot 2017-02-19 at 00 30 39" src="https://cloud.githubusercontent.com/assets/3050060/23097698/cfb4874e-f63a-11e6-80cf-ffbf5c5c6162.png ">
cc @SergioBenitez
r? @rust-lang/docs
2017-02-28 22:55:28 -05:00
Jeffrey Seyfried
0cc7053efa
Remove Token::MatchNt.
2017-02-28 22:15:09 +00:00
Guillaume Gomez
d06f72d062
Apply the same transformation to every types
2017-02-28 00:27:19 +01:00
Guillaume Gomez
5ac7a035af
Put the const type and value into <code>
2017-02-26 18:55:07 +01:00
Guillaume Gomez
081336e8eb
Improve associated constant rendering in rustdoc
2017-02-26 15:50:53 +01:00
Guillaume Gomez
8c8eda8ecd
Fix nightly-only experimental API display
2017-02-25 17:48:09 +01:00
Guillaume Gomez
74204a0ce7
Rollup merge of #39740 - jimmycuadra:rustdoc-empty-stability, r=aturon
...
rustdoc: Only include a stability span if needed.
This patch gets rid of the empty stability boxes in docs by only including the span that creates it when the item actually has a stability class.
Here are images of the issue on `std::process::Output`:
Before:
<img width="340" alt="before" src="https://cloud.githubusercontent.com/assets/122457/22853638/ff88d1b2-f010-11e6-90d6-bf3d10e2fffa.png ">
After:
<img width="333" alt="after" src="https://cloud.githubusercontent.com/assets/122457/22853639/06bfe7cc-f011-11e6-9892-f0ea2cc6ec90.png ">
This is my first non-trivial patch to Rust, so I'm sure some of my approach is not idiomatic. Let me know how you'd like me to adjust!
2017-02-12 19:16:31 +01:00
Guillaume Gomez
0095ec25cc
Rollup merge of #39697 - notriddle:rustdoc_tooltip, r=GuillaumeGomez
...
Add the item type to the tooltip
See:
https://users.rust-lang.org/t/seeking-opinions-from-colorblind-rustaceans-coloring-in-rustdoc-code-blocks
2017-02-12 19:16:30 +01:00
Guillaume Gomez
be0e7498f0
Rollup merge of #39654 - ollie27:rustdoc_attributes, r=GuillaumeGomez
...
rustdoc: Show attributes on all item types
Currently attributes are only shown for structs, unions and enums but
they should be shown for all items. For example it is useful to know if a
function is `#[no_mangle]`.
2017-02-12 19:16:28 +01:00
Jimmy Cuadra
bd14c7f333
Remove extra closing span element.
2017-02-11 07:10:03 -08:00
Jimmy Cuadra
c603839d5f
rustdoc: Only include a stability span if needed.
2017-02-11 04:16:13 -08:00
Michael Howell
bc4ad1a2c9
Add the short type to inline links, too
2017-02-09 11:02:01 -07:00
Michael Howell
fce944d4e7
Add the item type to the tooltip
...
See:
https://users.rust-lang.org/t/seeking-opinions-from-colorblind-rustaceans-coloring-in-rustdoc-code-blocks
2017-02-09 10:38:29 -07:00
Corey Farwell
4f6868aa01
Rollup merge of #39589 - ollie27:rustdoc_impl_disambiguation, r=alexcrichton
...
rustdoc: Improve impl disambiguation
* Don't disambiguate if there are multiple impls for the same type.
* Disambiguate for impls of &Foo and &mut Foo.
* Don't try to disambiguate generic types.
[before](https://doc.rust-lang.org/nightly/std/ops/trait.Rem.html#implementors ) [after](https://ollie27.github.io/rust_doc_test/std/ops/trait.Rem.html#implementors )
2017-02-08 23:55:44 -05:00
Oliver Middleton
147d173d02
rustdoc: Show attributes on all item types
...
Currently attributes are only shown for structs, unions and enums but
they should be shown for all items. For example it is useful to know if a
function is `#[no_mangle]`.
2017-02-08 21:15:20 +00:00
Corey Farwell
722baed173
Rollup merge of #39597 - GuillaumeGomez:correct_rustdoc_test_file, r=alexcrichton
...
Display correct filename with --test option
Fixes #39592 .
With the current files:
```rust
pub mod foo;
/// This is a Foo;
///
/// ```
/// println!("baaaaaar");
/// ```
pub struct Foo;
/// This is a Bar;
///
/// ```
/// println!("fooooo");
/// ```
pub struct Bar;
```
```rust
// note the whitespaces
/// ```
/// println!("foo");
/// ```
pub fn foo() {}
```
It displays:
```
./build/x86_64-apple-darwin/stage1/bin/rustdoc --test test.rs
running 3 tests
test test.rs - line 13 ... ok
test test.rs - line 5 ... ok
test foo.rs - line 2 ... ok
test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured
```
```
` ``
println!("lol");
` ``
asdjnfasd
asd
```
It displays:
```
./build/x86_64-apple-darwin/stage1/bin/rustdoc --test foo.md
running 1 test
test <input> - line 3 ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured
```
r? @alexcrichton
2017-02-08 10:19:55 -05:00
Guillaume Gomez
b0803d4aed
Display correct filename with --test option
2017-02-06 22:11:03 +01:00
Oliver Middleton
05eef36fa5
rustdoc: Improve impl disambiguation
...
* Don't disambiguate if there are multiple impls for the same type.
* Disambiguate for impls of &Foo and &mut Foo.
* Don't try to disambiguate generic types.
2017-02-06 18:11:01 +00:00
Alex Crichton
77c3bfa742
std: Remove cfg(cargobuild) annotations
...
These are all now no longer needed that we've only got rustbuild in tree.
2017-02-06 08:42:54 -08:00
