user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
119653 commits 10 branches 154 tags 1.3 GiB
Commit graph

133 commits

Author SHA1 Message Date
Theo Sandstrom
d55c3998e0 Corrects a typo in rustdoc documentation. 
Fixes rust-lang#70856
 2020-04-07 18:37:35 -04:00
Mazdak Farrokhzad
e37e81cad5
Rollup merge of #69494 - GuillaumeGomez:stabilize-crate-version, r=ehuss,aleksator,ollie27 
Stabilize --crate-version option in rustdoc

I don't see any reason to not stabilize it anymore, so let's go!

cc @kinnison @ehuss

r? @ollie27
 2020-03-23 19:04:45 +01:00
Timothée Gerber
6d521ecc62 Fix punctuation in rustdoc book 2020-03-14 23:40:29 +01:00
Timothée Gerber
131433a2c0 Change fenced code block type in rustdoc book 2020-03-14 23:31:34 +01:00
Timothée Gerber
68dc24fcbe Clean up path separator in rustdoc book 2020-03-14 23:04:33 +01:00
Mazdak Farrokhzad
61150353bf
Rollup merge of #69514 - GuillaumeGomez:remove-spotlight, r=kinnison 
Remove spotlight

I had a few comments saying that this feature was at best misunderstood or not even used so I decided to organize a poll about on [twitter](https://twitter.com/imperioworld_/status/1232769353503956994). After 87 votes, the result is very clear: it's not useful. Considering the amount of code we have just to run it, I think it's definitely worth it to remove it.

r? @kinnison

cc @ollie27
 2020-03-10 06:47:47 +01:00
Matthias Krüger
136ad015b6 fix various typos 2020-03-06 15:19:31 +01:00
Guillaume Gomez
1244ced958 Remove "important traits" feature 2020-02-27 14:51:22 +01:00
Guillaume Gomez
c57de34e8f Stabilize --crate-version option in rustdoc 2020-02-26 22:08:59 +01:00
Eric Huss
1e1b6ad108 Update books. 2020-02-13 08:11:09 -08:00
king6cong
9713b5696b doc fix on doc attribute 2020-02-05 12:56:24 +08:00
Parth Mehrotra
395408ec18
Update documentation-tests.md 2019-11-25 19:34:32 -05:00
QuietMisdreavus
0d7a7b5547 move cfg(doc) docs into a separate page 2019-11-21 15:38:30 +01:00
Guillaume Gomez
a056bf9714 Rename the cfg attribute from rustdoc to doc 2019-11-21 15:38:30 +01:00
Guillaume Gomez
086c8d3db7 Stabilize cfg rustdoc 2019-11-21 15:37:36 +01:00
Guillaume Gomez
71c7dace89 improve error messages and documentation 2019-11-18 16:43:48 +01:00
Guillaume Gomez
530d866aef Apply review comments 2019-11-18 16:43:48 +01:00
Guillaume Gomez
8f9014d98f Rename rustdoc options --themes and --check-themes to --theme and --check-theme 2019-11-18 16:43:48 +01:00
Guillaume Gomez
685b63a163 remove unstable docs 2019-11-18 16:43:48 +01:00
Guillaume Gomez
bbfd63c89a Improve documentation, add checks for themes option arguments, make sure the themes file names are js compatible 2019-11-18 16:43:48 +01:00
Guillaume Gomez
6f2d1f51eb Fix typos 
Co-Authored-By: Oliver Middleton <olliemail27@gmail.com>
 2019-11-18 16:43:48 +01:00
Guillaume Gomez
8f44c604d2 Rename theme-checker option to check-theme 2019-11-18 16:43:48 +01:00
Guillaume Gomez
f3e4279ccc Apply review comments 2019-11-18 16:43:47 +01:00
Guillaume Gomez
3eba28432f Add documentation for stabilized flags 2019-11-18 16:43:47 +01:00
Yuki Okushi
6eea5001b5
Rollup merge of #66166 - GuillaumeGomez:rename-rustdoc-to-doc, r=QuietMisdreavus 
rename cfg(rustdoc) into cfg(doc)

Needed by https://github.com/rust-lang/rust/pull/61351

r? @QuietMisdreavus
 2019-11-13 22:09:13 +09:00
Guillaume Gomez
528b0590b1 Add rustdoc doc page for lints 2019-11-10 23:06:24 +01:00
Guillaume Gomez
af5f84fa4f Add rustdoc doc page on how to write documentation 2019-11-10 23:06:24 +01:00
Guillaume Gomez
0282c27781 rename cfg(rustdoc) into cfg(doc) 2019-11-06 18:32:51 +01:00
Guillaume Gomez
1595fdee1f Update since version for doctest feature 2019-10-29 13:42:55 +01:00
Guillaume Gomez
3e3d919dab improve documentation of rustdoc doctest feature 2019-10-29 13:42:55 +01:00
Guillaume Gomez
a212960a4b stabilize cfg(doctest) 2019-10-29 13:42:55 +01:00
Dario Gonzalez
14110ebd93 added rustdoc book documentation, improved behavior when unstable flag not present 2019-09-03 13:53:00 -07:00
Andreas Jonson
f0b30c7ded remove the unstable rustdoc parameter --linker 
use the code generation parameter -Clinker (same parameter as rustc)
to control what linker to use for building the rustdoc test executables.

closes: #63816
 2019-09-01 08:50:23 +02:00
Jonas Schievink
1cc7c211f5 Adjust docs to new #[doc(include)] behaviour 2019-07-23 17:17:31 +02:00
QuietMisdreavus
bed54cf854 rustdoc: set cfg(doctest) when collecting doctests 2019-07-06 21:37:17 -05:00
Guillaume Gomez
a683bb1754 Revert "implicit Option-returning doctests" 
This reverts commit 6bb6c001be.
 2019-07-01 16:41:37 +02:00
Pietro Albini
f100dfbb3e
Rollup merge of #61372 - mati865:books, r=Centril,GuillaumeGomez 
Migrate some books to mdbook version 0.2

There are 3 books still using old version but they need more effort so I hope to do them in subsequent PR if I find the time.
 2019-05-31 13:34:06 +02:00
Mateusz Mikuła
5f929be162 Migrate rustdoc book to MdBook2 2019-05-30 14:22:33 +02:00
Andre Bogus
6bb6c001be implicit Option-returning doctests 
This distinguishes `Option` and `Result`-returning doctests with
implicit `main` method, where the former tests must end with
`Some(())`.
 2019-05-28 19:10:39 +02:00
airt
dbf8c6df9d
docs: fix typo #61197 2019-05-26 12:17:33 +08:00
Manish Goregaokar
2ae06976e4
Rollup merge of #60278 - ehuss:doc-html_root_url, r=GuillaumeGomez 
Document the `html_root_url` doc attribute value.

I'm not sure if this was intentionally not documented, but I think it would be good to include. This was added in #9691.  `--extern-html-root-url` is unstable, but I don't think it hurts to mention it.
 2019-05-16 12:31:44 -07:00
Eric Huss
2e3d5c866f Document the html_root_url doc attribute value. 2019-04-25 11:44:40 -07:00
Felix Rabe
28234751bc Outdent example, preserving nested fence 2019-04-23 20:27:09 +02:00
QuietMisdreavus
74cf1adfd6 tweak docs for rustdoc's --show-coverage 2019-02-28 16:13:55 -06:00
QuietMisdreavus
80b49191bb update docs for doc coverage 2019-02-28 16:11:21 -06:00
QuietMisdreavus
9e98a25b95 tabs -> spaces 2019-02-28 16:01:27 -06:00
QuietMisdreavus
009c91a294 add option to calculate documentation coverage 2019-02-28 16:01:27 -06:00
Andre Bogus
8cf3605c50 fix typo 2019-02-20 17:59:17 +01:00
kennytm
5a06eab1f5
Rollup merge of #56470 - llogiq:process-termination-doctest, r=GuillaumeGomez 
Modify doctest's auto-`fn main()` to allow `Result`s

This lets the default `fn main()` ~~return `impl Termination`~~ unwrap Results, which allows the use of `?` in most tests without adding it manually. This fixes #56260

~~Blocked on `std::process::Termination` stabilization.~~

Using `Termination` would have been cleaner, but this should work OK.
 2019-02-20 01:13:12 +08:00
Andre Bogus
dad211ef9f Modify doctest's auto-fn main() to allow Results 
This lets the default `fn main()` unwrap any `Result`s, which
allows the use of `?` in most tests without adding it manually.
 2019-02-17 16:42:49 +01:00