summary refs log tree commit diff
path: root/src/doc/rustdoc
AgeCommit message (Collapse)AuthorLines
2021-04-05Apply suggestions from code reviewJoshua Nelson-1/+1
Co-authored-by: Camelid <camelidcamel@gmail.com> Co-authored-by: Nemo157 <github@nemo157.com>
2021-04-05Rename non_autolinks -> bare_urlsJoshua Nelson-15/+8
2021-04-02Auto merge of #80965 - camelid:rename-doc-spotlight, r=jyn514bors-20/+22
Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]` Fixes #80936. "spotlight" is not a very specific or self-explaining name. Additionally, the dialog that it triggers is called "Notable traits". So, "notable trait" is a better name. * Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]` * Rename `#![feature(doc_spotlight)]` to `#![feature(doc_notable_trait)]` * Update documentation * Improve documentation r? `@Manishearth`
2021-03-15Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]`Camelid-20/+22
"spotlight" is not a very specific or self-explaining name. Additionally, the dialog that it triggers is called "Notable traits". So, "notable trait" is a better name. * Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]` * Rename `#![feature(doc_spotlight)]` to `#![feature(doc_notable_trait)]` * Update documentation * Improve documentation
2021-03-10Allow doc alias attributes to use both list and valueGuillaume Gomez-0/+7
2021-03-04Rollup merge of #82690 - jyn514:remove-pass-docs, r=ManishearthGuillaume Gomez-132/+67
Update rustdoc documentation - Remove most of the information about passes. Passes are deprecated. - Add `--document-private-items`; it was missing before. - Update `--output-format json`; it was very outdated. - Note that `--input-format` is deprecated. - Move deprecated options to the very end. Closes https://github.com/rust-lang/rust/issues/82675. r? `@Manishearth`
2021-03-04Update rustdoc documentationJoshua Nelson-132/+67
- Remove most of the information about passes. Passes are deprecated. - Add `--document-private-items`; it was missing before. - Update `--output-format json`; it was very outdated. - Note that `--input-format` is deprecated. - Move deprecated options to the very end. - Move `passes.html` to the end of the table of contents. Ideally it would be removed altogether, but that causes mdbook not to generate the docs.
2021-03-04Rollup merge of #80527 - jyn514:rustdoc-lints, r=GuillaumeGomezYuki Okushi-14/+21
Make rustdoc lints a tool lint instead of built-in - Rename `broken_intra_doc_links` to `rustdoc::broken_intra_doc_links` (and similar for other rustdoc lints; I don't expect any others to be used frequently, though). - Ensure that the old lint names still work and give deprecation errors - Register lints even when running doctests - Move lint machinery into a separate file - Add `declare_rustdoc_lint!` macro Unblocks https://github.com/rust-lang/rust/pull/80300, https://github.com/rust-lang/rust/pull/79816, https://github.com/rust-lang/rust/pull/80965. Makes the strangeness in https://github.com/rust-lang/rust/pull/77364 more apparent to the end user (note that `missing_docs` is *not* moved to rustdoc in this PR). Closes https://github.com/rust-lang/rust/issues/78786. ## Current status This is blocked on #82620 (see https://github.com/rust-lang/rust/pull/80527#issuecomment-787401519)
2021-03-02Rollup merge of #80874 - jyn514:intra-doc-docs, r=ManishearthYuki Okushi-13/+62
Update intra-doc link documentation to match the implementation r? `@Manishearth` cc `@camelid` `@m-ou-se` Relevant PRs: - https://github.com/rust-lang/rust/pull/74489 - https://github.com/rust-lang/rust/pull/80181 - https://github.com/rust-lang/rust/pull/76078 - https://github.com/rust-lang/rust/pull/77519 - https://github.com/rust-lang/rust/pull/73101 Relevant issues: - https://github.com/rust-lang/rust/issues/78800 - https://github.com/rust-lang/rust/issues/77200 - https://github.com/rust-lang/rust/issues/77199 / https://github.com/rust-lang/rust/issues/54191/ I haven't documented things that I consider 'just bugs', like https://github.com/rust-lang/rust/issues/77732, but I have documented features that aren't implemented, like https://github.com/rust-lang/rust/issues/78800.
2021-03-01Address review commentsJoshua Nelson-14/+21
- Move MISSING_CRATE_LEVEL_DOCS to rustdoc directly - Update documentation This also takes the opportunity to make the `no-crate-level-doc-lint` test more specific.
2021-02-22Fix compile failure due to 2015 module system being weirdJoshua Nelson-1/+1
2021-02-23Rollup merge of #79423 - camelid:smart-punct, r=jyn514Dylan DPC-5/+21
Enable smart punctuation Closes #76690.
2021-02-18Don't include quite so much detail about the implementationJoshua Nelson-34/+16
2021-02-19Rollup merge of #82261 - ojeda:rustdoc-argfile, r=jyn514Dylan DPC-0/+7
rustdoc: Support argument files Factors out the `rustc_driver` logic that handles argument files so that rustdoc supports them as well, e.g.: rustdoc `@argfile` This is needed to be able to generate docs for projects that already use argument files when compiling them, e.g. projects that pass a huge number of `--cfg` arguments. The feature was stabilized for `rustc` in #66172.
2021-02-19rustdoc: Support argument filesMiguel Ojeda-0/+7
Factors out the `rustc_driver` logic that handles argument files so that rustdoc supports them as well, e.g.: rustdoc @argfile This is needed to be able to generate docs for projects that already use argument files when compiling them, e.g. projects that pass a huge number of `--cfg` arguments. The feature was stabilized for `rustc` in #66172. Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
2021-02-07Document smart punctuationCamelid-5/+21
2021-02-06Rollup merge of #81766 - jyn514:task-lists, r=GuillaumeGomezJonas Schievink-0/+20
Enable 'task list' markdown extension Closes https://github.com/rust-lang/rust/issues/71183.
2021-02-06Enable 'task list' markdown extensionJoshua Nelson-0/+20
- Add documentation about task lists
2021-02-04Elaborate on rustdoc example reason for being ignored.Eric Huss-2/+2
2021-02-04tidy: Run tidy style against markdown files.Eric Huss-67/+83
2021-01-25rustdoc: Document CommonMark extensions.Eric Huss-1/+65
2021-01-10Fix relative linksJoshua Nelson-8/+8
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-10Fix typoJoshua Nelson-1/+1
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-10Address review commentsJoshua Nelson-25/+41
- Improve wording - Use relative links - Use a proper list instead of a wall of text - Improve examples
2021-01-10Document differences from markdownJoshua Nelson-0/+3
2021-01-10Update intra-doc link documentation to match the implementationJoshua Nelson-8/+56
2020-12-28Rollup merge of #80410 - MarcoIeni:patch-1, r=jonas-schievinkMara Bos-1/+1
rustdoc book: fix example `lib.rs` file is created only if `--lib` flag is specified
2020-12-28Rollup merge of #80393 - ehuss:doc-git-link, r=jyn514Mara Bos-0/+3
Add links to the source for the rustc and rustdoc books. This adds a little icon in the upper-right corner of the books so that readers can find the source if they want to make changes or file issues. This is already included in several of the other books.
2020-12-27rustdoc book: fix exampleMarco Ieni-1/+1
2020-12-26Add links to the source for the rustc and rustdoc books.Eric Huss-0/+3
2020-12-03fix typo in src/doc/rustdoc/src/command-line-arguments.mdIan Jackson-1/+1
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
2020-12-03rustdoc: document --default-theme option in command line docIan Jackson-0/+20
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
2020-11-06Auto merge of #75778 - AndyGauge:75521-rustdoc-book-improvements, r=jyn514bors-31/+282
75521 rustdoc book improvements Added some guidelines about documenting with rustdoc Fixes #75521
2020-11-05Rename lint to non_autolinksGuillaume Gomez-2/+2
2020-11-05Update URLs used in the lint exampleGuillaume Gomez-14/+15
2020-11-05Rename automatic_links to url_improvementsGuillaume Gomez-1/+1
2020-11-05Improve automatic_links globallyGuillaume Gomez-10/+3
2020-11-05Extend automatic_links lint to take into account URLs without link syntaxGuillaume Gomez-9/+13
2020-11-05Add documentation for automatic_links lintGuillaume Gomez-0/+40
2020-11-04Added Rustdoc book sections for linting and embedding more examplesAndrew Gauger-31/+282
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-28Fix typo "compiltest"Guillaume Gomez-1/+1
2020-10-21Clean up and improve some docsCamelid-13/+15
* compiler docs * Don't format list as part of a code block * Clean up some other formatting * rustdoc book * Update CommonMark spec version to latest (0.28 -> 0.29) * Clean up some various wording and formatting
2020-10-09Link to GitHub issue re macro resolutionCamelid-1/+3
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08Update rustdoc intra-doc link docsCamelid-13/+40
* Describe generic parameters feature * Make general improvements to the docs
2020-10-07Auto merge of #77119 - GuillaumeGomez:unclosed-html-tag-lint, r=jyn514bors-0/+35
Unclosed html tag lint Part of #67799. I think `@ollie27` will be interested (`@Manishearth` too since they opened the issue ;) ). r? `@jyn514`
2020-10-06Rollup merge of #76855 - jyn514:platform-specific, r=ollie27Yuki Okushi-21/+50
Revamp rustdoc docs about documentation using `cfg` - Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features Addresses https://github.com/rust-lang/rust/pull/76849#issuecomment-694516199. Obsoletes https://github.com/rust-lang/rust/pull/76849 (I made sure to fix the weird dashes too). r? @steveklabnik
2020-10-05Revamp rustdoc docs about documentation using `cfg`Joshua Nelson-21/+50
- Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features
2020-10-03Make invalid_html_tags lint only run on nightly and being allowed by defaultGuillaume Gomez-2/+4
2020-10-03Add doc for invalid_html_tag lintGuillaume Gomez-0/+33
2020-10-02Rollup merge of #76811 - GuillaumeGomez:doc-alias-name-restriction, ↵Jonas Schievink-0/+2
r=oli-obk,ollie27 Doc alias name restriction Fixes #76705.
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-26 16:23:02 +0000