summary refs log tree commit diff
path: root/src/doc/rustdoc
AgeCommit message (Collapse)AuthorLines
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.
2019-02-09Some writing improvement, conciseness of introRobert Hayek-4/+3
2019-01-17Bless test.Wesley Norris-1/+9
Bless test, remove submodule, and fix book entry. bless test again? maybe it'll work this time...
2019-01-17Add book section and fix typo.Wesley Norris-0/+4
2019-01-03Fix repeated word typosWiktor Kuchta-1/+1
Found with `git grep -P '\b([a-z]+)\s+\1\b'`
2018-12-20new --static-root-path flag for controlling static file locationsQuietMisdreavus-0/+15
2018-11-09don't inline `pub use some_crate` unless directly asked toQuietMisdreavus-0/+3
2018-11-02Move doc_alias docGuillaume Gomez-16/+16
2018-11-02Add documentation for index-page featuresGuillaume Gomez-0/+13
2018-09-20Add documentation about the edition flagPhilip Munksgaard-0/+16
2018-09-09Stabilize the 2018 editionMark Rousskov-13/+14
2018-09-01Rollup merge of #53076 - QuietMisdreavus:cfg-rustdoc, r=GuillaumeGomezkennytm-11/+9
set cfg(rustdoc) when rustdoc is running on a crate When using `#[doc(cfg)]` to document platform-specific items, it's a little cumbersome to get all the platforms' items to appear all at once. For example, the standard library adds `--cfg dox` to rustdoc's command line whenever it builds docs, and the documentation for `#![feature(doc_cfg)]` suggests using a Cargo feature to approximate the same thing. This is a little awkward, because you always need to remember to set `--features dox` whenever you build documentation. This PR proposes making rustdoc set `#[cfg(rustdoc)]` whenever it runs on a crate, to provide an officially-sanctioned version of this that is set automatically. This way, there's a standardized way to declare that a certain version of an item is specifically when building docs. To try to prevent the spread of this feature from happening too quickly, this PR also restricts the use of this flag to whenever `#![feature(doc_cfg)]` is active. I'm sure there are other uses for this, but right now i'm tying it to this feature. (If it makes more sense to give this its own feature, i can easily do that.)
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-03-12 04:43:11 +0000