about summary refs log tree commit diff
path: root/src/doc/rustdoc
AgeCommit message (Collapse)AuthorLines
2020-04-07Corrects a typo in rustdoc documentation.Theo Sandstrom-3/+3
Fixes rust-lang#70856
2020-03-23Rollup merge of #69494 - GuillaumeGomez:stabilize-crate-version, ↵Mazdak Farrokhzad-12/+12
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-14Fix punctuation in rustdoc bookTimothée Gerber-1/+1
2020-03-14Change fenced code block type in rustdoc bookTimothée Gerber-1/+1
2020-03-14Clean up path separator in rustdoc bookTimothée Gerber-5/+5
2020-03-10Rollup merge of #69514 - GuillaumeGomez:remove-spotlight, r=kinnisonMazdak Farrokhzad-21/+0
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-06fix various typosMatthias Krüger-1/+1
2020-02-27Remove "important traits" featureGuillaume Gomez-21/+0
2020-02-26Stabilize --crate-version option in rustdocGuillaume Gomez-12/+12
2020-02-13Update books.Eric Huss-0/+4
2020-02-05doc fix on doc attributeking6cong-1/+1
2019-11-25Update documentation-tests.mdParth Mehrotra-1/+1
2019-11-21move cfg(doc) docs into a separate pageQuietMisdreavus-31/+35
2019-11-21Rename the cfg attribute from rustdoc to docGuillaume Gomez-5/+5
2019-11-21Stabilize cfg rustdocGuillaume Gomez-0/+31
2019-11-18improve error messages and documentationGuillaume Gomez-13/+21
2019-11-18Apply review commentsGuillaume Gomez-1/+1
2019-11-18Rename rustdoc options --themes and --check-themes to --theme and --check-themeGuillaume Gomez-4/+4
2019-11-18remove unstable docsGuillaume Gomez-26/+2
2019-11-18Improve documentation, add checks for themes option arguments, make sure the ↵Guillaume Gomez-1/+4
themes file names are js compatible
2019-11-18Fix typosGuillaume Gomez-2/+2
Co-Authored-By: Oliver Middleton <olliemail27@gmail.com>
2019-11-18Rename theme-checker option to check-themeGuillaume Gomez-5/+5
2019-11-18Apply review commentsGuillaume Gomez-2/+2
2019-11-18Add documentation for stabilized flagsGuillaume Gomez-1/+21
2019-11-13Rollup merge of #66166 - GuillaumeGomez:rename-rustdoc-to-doc, r=QuietMisdreavusYuki Okushi-4/+4
rename cfg(rustdoc) into cfg(doc) Needed by https://github.com/rust-lang/rust/pull/61351 r? @QuietMisdreavus
2019-11-10Add rustdoc doc page for lintsGuillaume Gomez-0/+126
2019-11-10Add rustdoc doc page on how to write documentationGuillaume Gomez-0/+77
2019-11-06rename cfg(rustdoc) into cfg(doc)Guillaume Gomez-4/+4
2019-10-29Update since version for doctest featureGuillaume Gomez-1/+1
2019-10-29improve documentation of rustdoc doctest featureGuillaume Gomez-7/+22
2019-10-29stabilize cfg(doctest)Guillaume Gomez-30/+31
2019-09-03added rustdoc book documentation, improved behavior when unstable flag not ↵Dario Gonzalez-0/+50
present
2019-09-01remove the unstable rustdoc parameter --linkerAndreas Jonson-13/+0
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-07-23Adjust docs to new #[doc(include)] behaviourJonas Schievink-3/+2
2019-07-06rustdoc: set cfg(doctest) when collecting doctestsQuietMisdreavus-0/+30
2019-07-01Revert "implicit `Option`-returning doctests"Guillaume Gomez-13/+0
This reverts commit 6bb6c001be34d0932a014df981ee18f165c43374.
2019-05-31Rollup merge of #61372 - mati865:books, r=Centril,GuillaumeGomezPietro Albini-6/+6
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-30Migrate rustdoc book to MdBook2Mateusz Mikuła-6/+6
2019-05-28implicit `Option`-returning doctestsAndre Bogus-0/+13
This distinguishes `Option` and `Result`-returning doctests with implicit `main` method, where the former tests must end with `Some(())`.
2019-05-26docs: fix typo #61197airt-1/+1
2019-05-16Rollup merge of #60278 - ehuss:doc-html_root_url, r=GuillaumeGomezManish Goregaokar-0/+15
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-04-25Document the `html_root_url` doc attribute value.Eric Huss-0/+15
2019-04-23Outdent example, preserving nested fenceFelix Rabe-10/+10
2019-02-28tweak docs for rustdoc's `--show-coverage`QuietMisdreavus-4/+8
2019-02-28update docs for doc coverageQuietMisdreavus-2/+4
2019-02-28tabs -> spacesQuietMisdreavus-4/+4
2019-02-28add option to calculate documentation coverageQuietMisdreavus-0/+21
2019-02-20fix typoAndre Bogus-1/+1
2019-02-20Rollup merge of #56470 - llogiq:process-termination-doctest, r=GuillaumeGomezkennytm-0/+17
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-17Modify doctest's auto-`fn main()` to allow `Result`sAndre Bogus-0/+17
This lets the default `fn main()` unwrap any `Result`s, which allows the use of `?` in most tests without adding it manually.