summary refs log tree commit diff
path: root/src/doc/rustdoc
AgeCommit message (Collapse)AuthorLines
2018-04-01Rollup merge of #49451 - QuietMisdreavus:epoch-doctests, r=GuillaumeGomezMark Simulacrum-0/+13
rustdoc: add an --edition flag to compile docs/doctests with a certain edition To correspond with the 2018 edition, this adds a (currently unstable) `--edition` flag to rustdoc that makes it compile crates and doctests with the given edition. Once this lands, Cargo should be updated to pass this flag when the edition configuration option is given.
2018-03-29Rename main theme into light themeGuillaume Gomez-3/+3
2018-03-27talk about --edition in the Rustdoc BookQuietMisdreavus-0/+13
2018-03-23Rollup merge of #49028 - ↵Alex Crichton-0/+363
QuietMisdreavus:the-dark-forbidden-corners-of-rustdoc, r=frewsxcv add an "unstable features" chapter to the rustdoc book There are several rustdoc features that currently are undocumented, but also don't fit with the rest of the Rustdoc Book since they're also unstable. Some of these have corresponding feature gates and chapters in the Unstable Book, but many don't, and i wanted a place to talk about them officially. Goal: talk about everything rustdoc can do that needs nightly - [x] Feature gates (extensions to the doc attribute that can be caught by the compiler) - [x] doc(cfg) - [x] doc(masked) - [x] doc(spotlight) - [x] doc(include) - [x] Command-line flags (features that require a CLI flag to use, where the flag itself is a `-Z` command or otherwise requires `-Z unstable-options` before rustdoc will accept it) - [x] markdown-before-content/markdown-after-content - [x] playground-url - [x] display-warnings - [x] crate-version - [x] linker - [x] sort-modules-by-appearance - [x] themes/theme-checker - [x] resource-suffix - [x] `-Z force-unstable-if-unmarked` - [x] Nightly-gated functionality (features that are gated by requiring a nightly build without needing a CLI flag or a feature gate to unlock) - [x] intra-links - [x] error numbers for `compile_fail` doctests
2018-03-21review commentsQuietMisdreavus-11/+13
2018-03-20talk about force-unstable-if-unmarkedQuietMisdreavus-0/+13
2018-03-20talk about --display-warningsQuietMisdreavus-0/+16
2018-03-16talk about --resource-suffixQuietMisdreavus-0/+13
2018-03-16talk about --themes and --theme-checkerQuietMisdreavus-0/+24
2018-03-16talk about --sort-modules-by-appearanceQuietMisdreavus-0/+13
2018-03-16talk about --linkerQuietMisdreavus-0/+13
2018-03-16talk about --crate-versionQuietMisdreavus-0/+12
2018-03-15talk about --playground-urlQuietMisdreavus-0/+23
2018-03-16Rollup merge of #48961 - Songbird0:rustdoc_doctests_assertions, r=GuillaumeGomezkennytm-0/+16
Rustdoc: example of use of assertions I added this section at the beginning of the file because it seems to be basic information. Let me know if there's someplace more relevant. See #47945.
2018-03-15talk about --markdown-(before|after)-contentQuietMisdreavus-0/+28
2018-03-15add new section about CLI flagsQuietMisdreavus-0/+7
2018-03-15fix linkQuietMisdreavus-1/+1
2018-03-14add headings to categorize the featuresQuietMisdreavus-6/+18
2018-03-14talk about doc(include)QuietMisdreavus-3/+19
2018-03-14talk about doc(masked)QuietMisdreavus-0/+20
2018-03-14talk about doc(spotlight)QuietMisdreavus-0/+20
2018-03-14talk about doc(cfg)QuietMisdreavus-0/+52
2018-03-13talk about intra-linksQuietMisdreavus-0/+45
2018-03-13Add a section for using assertions into doc tests.Anthony Defranceschi-0/+16
See #47945.
2018-03-12talk about error numbers for compile_fail doctestsQuietMisdreavus-0/+23
2018-03-12add page to the Rustdoc Book about unstable featuresQuietMisdreavus-0/+11
2018-03-12big fences to show that ```rust is the same as ```QuietMisdreavus-0/+4
2018-01-15Reexport -> re-export in documentation section headingsCarol (Nichols || Goulding)-3/+3
2017-11-21fix some typosMartin Lindhe-3/+3
2017-11-04rustdoc book: talk about #![doc(test(...))] in doctests chapterQuietMisdreavus-6/+8
2017-11-04rustdoc book: add #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))]QuietMisdreavus-0/+20
2017-10-17Rollup merge of #45308 - dbrgn:headlines, r=steveklabnikkennytm-3/+3
Rustdoc book: Add missing headlines Some options were missing headlines, which looked a bit inconsistent.
2017-10-15Rustdoc book: Add missing headlinesDanilo Bargen-3/+3
Some options were missing headlines, which looked a bit inconsistent.
2017-10-15Fix typo in rustdoc bookDanilo Bargen-3/+3
2017-09-03Add precision for rustdoc block codesGuillaume Gomez-0/+13
2017-09-03Add compile_fail documentationGuillaume Gomez-8/+20
2017-08-15Auto merge of #43863 - steveklabnik:ship-the-rustdoc-book, r=frewsxcvbors-32/+2
Ship the rustdoc book Fixes #42322, as it's the last step. Blocked on https://github.com/rust-lang/rust/pull/43790, though they will not conflict. r? @rust-lang/docs
2017-08-14Remove plugins chaptersteveklabnik-32/+2
we don't want to support plugins
2017-08-14Rollup merge of #43790 - steveklabnik:rustdoc-passes, r=QuietMisdreavusCorey Farwell-1/+84
Write the "passes" chapter of the rustdoc book cc #42322 r? @rust-lang/docs
2017-08-14Write the "passes" chapter of the rustdoc booksteveklabnik-1/+84
cc #42322
2017-08-12Auto merge of #43812 - steveklabnik:rustdoc-doc-tests, r=QuietMisdreavusbors-1/+237
rustdoc doc tests This is mostly adapted from the book v1's chapter. cc https://github.com/rust-lang/rust/issues/42322 r? @rust-lang/docs
2017-08-11rustdoc doc testssteveklabnik-1/+237
2017-08-11address review feedbacksteveklabnik-4/+10
2017-08-10ignore more thingssteveklabnik-4/+4
2017-08-10review feedbacksteveklabnik-4/+12
2017-08-10doc doc(inline) and doc(no_inline)steveklabnik-1/+57
2017-08-10Document the doc attributesteveklabnik-4/+109
cc #42322
2017-06-05fix testssteveklabnik-0/+2
2017-06-05address review feedbacksteveklabnik-18/+10
2017-06-02Coming soonsteveklabnik-0/+10
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-26 04:33:38 +0000