| Age | Commit message (Collapse) | Author | Lines | |
|---|---|---|---|---|
| 2025-09-30 | Replace `rustc_span::Span` with a stripped down version for librustdoc's ↵ | Yotam Ofek | -1/+2 | |
| highlighter | ||||
| 2025-08-28 | Create new `Item::is_fake_item` method as equivalent to check for ↵ | Guillaume Gomez | -1/+1 | |
| `is_primitive`, `is_keyword` and `is_attribute` methods | ||||
| 2025-08-28 | Add new `doc(attribute = "...")` attribute | Guillaume Gomez | -1/+1 | |
| 2025-08-23 | Do macro expansion at AST level rather than HIR | Guillaume Gomez | -14/+15 | |
| 2025-08-23 | Add new unstable `--generate-macro-expansion` rustdoc command line flag | Guillaume Gomez | -0/+2 | |
| 2025-08-23 | Add support for macro expansion in rustdoc source code pages | Guillaume Gomez | -2/+5 | |
| 2025-08-15 | rustdoc-search: search backend with partitioned suffix tree | Michael Howell | -0/+14 | |
| 2025-07-19 | Fix clippy lints in librustdoc | Guillaume Gomez | -47/+37 | |
| 2025-07-17 | Improve path segment joining. | Nicholas Nethercote | -2/+2 | |
| There are many places that join path segments with `::` to produce a string. A lot of these use `join("::")`. Many in rustdoc use `join_with_double_colon`, and a few use `.joined("..")`. One in Clippy uses `itertools::join`. A couple of them look for `kw::PathRoot` in the first segment, which can be important. This commit introduces `rustc_ast::join_path_{syms,ident}` to do the joining for everyone. `rustc_ast` is as good a location for these as any, being the earliest-running of the several crates with a `Path` type. Two functions are needed because `Ident` printing is more complex than simple `Symbol` printing. The commit also removes `join_with_double_colon`, and `estimate_item_path_byte_length` with it. There are still a handful of places that join strings with "::" that are unchanged. They are not that important: some of them are in tests, and some of them first split a path around "::" and then rejoin with "::". This fixes one test case where `{{root}}` shows up in an error message. | ||||
| 2025-06-19 | rustdoc: Remove `FormatRenderer::cache` | Alona Enraght-Moony | -4/+0 | |
| We only called it it one place, which isn't generic and can be replaced with a field access. | ||||
| 2025-06-11 | Avoid more clones in rustdoc JSON output. | Nicholas Nethercote | -1/+1 | |
| By making `JsonRenderer::item` take `&clean::Item` instead of a `clean::Item`. This required also changing `FromClean` and `IntoJson` methods to take references, which required a lot of follow-on sigil wrangling that is mostly tedious. | ||||
| 2025-06-10 | Simplify `JsonRenderer`. | Nicholas Nethercote | -1/+1 | |
| - It doesn't need to be cloneable. - Some of the `Rc`s and `RefCell`s aren't doing anything. - `after_krate` can consume `self`. | ||||
| 2025-05-26 | Rename some methods. | Nicholas Nethercote | -4/+4 | |
| Most of the methods returning `impl Display` have `print` in their name. This commit renames a few that didn't follow that convention. | ||||
| 2025-05-20 | Get rid of unnecessary `BufDisplay` abstraction | Yotam Ofek | -5/+2 | |
| 2025-05-20 | Make some fns return `fmt::Result` to get rid of a few `unwrap`s | Yotam Ofek | -1/+1 | |
| 2025-04-17 | Replace infallible `name_or_empty` methods with fallible `name` methods. | Nicholas Nethercote | -6/+6 | |
| I'm removing empty identifiers everywhere, because in practice they always mean "no identifier" rather than "empty identifier". (An empty identifier is impossible.) It's better to use `Option` to mean "no identifier" because you then can't forget about the "no identifier" possibility. Some specifics: - When testing an attribute for a single name, the commit uses the `has_name` method. - When testing an attribute for multiple names, the commit uses the new `has_any_name` method. - When using `match` on an attribute, the match arms now have `Some` on them. In the tests, we now avoid printing empty identifiers by not printing the identifier in the `error:` line at all, instead letting the carets point out the problem. | ||||
| 2025-04-10 | make `AllTypes::print` return `impl fmt::Display` | Yotam Ofek | -9/+1 | |
| 2025-04-03 | Update to new rinja version (askama) | Guillaume Gomez | -1/+1 | |
| 2025-02-23 | return `impl fmt::Display` in more places instead of writing to strings | Yotam Ofek | -3/+2 | |
| 2025-02-14 | librustdoc: lazily format some paths | Yotam Ofek | -6/+6 | |
| 2025-02-14 | librustdoc: make `item_path` formatting lazy | Yotam Ofek | -7/+12 | |
| 2025-02-12 | Nuke `Buffer` abstraction from `librustdoc` 💣 | Yotam Ofek | -32/+35 | |
| 2025-01-30 | fix(rustdoc): always use a channel when linking to doc.rust-lang.org | Alexis (Poliorcetics) Bourget | -2/+2 | |
| 2024-12-25 | Improve rustdoc code | Guillaume Gomez | -1/+1 | |
| 2024-12-02 | rustdoc: Rename set_back_info to restore_module_data. | Alona Enraght-Moony | -1/+1 | |
| 2024-12-01 | Fix link to `FormatRenderer` method | Guillaume Gomez | -1/+1 | |
| 2024-12-01 | Rename `FormatRenderer::InfoType` into `ModuleData` and rename ↵ | Guillaume Gomez | -3/+3 | |
| `FormatRenderer::make_child_renderer` into `save_module_data` | ||||
| 2024-12-01 | Add documentation for new `FormatRenderer` trait items | Guillaume Gomez | -0/+6 | |
| 2024-12-01 | Move `SharedContext` out of `Rc` | Guillaume Gomez | -25/+20 | |
| 2024-12-01 | Split ID maps in two parts: the constant one and the updated one | Guillaume Gomez | -6/+0 | |
| 2024-12-01 | Stop cloning `Context` so much | Guillaume Gomez | -32/+43 | |
| 2024-11-28 | Fix new clippy lints | Guillaume Gomez | -4/+4 | |
| 2024-11-13 | Fix duplicated footnote IDs | Guillaume Gomez | -2/+2 | |
| 2024-10-06 | Handle `librustdoc` cases of `rustc::potential_query_instability` lint | ismailarilik | -7/+7 | |
| 2024-09-22 | Reformat using the new identifier sorting from rustfmt | Michael Goulet | -7/+7 | |
| 2024-09-10 | Auto merge of #129337 - EtomicBomb:rfc, r=notriddle | bors | -84/+91 | |
| rustdoc rfc#3662 changes under unstable flags * All new functionality is under unstable options * Adds `--merge=shared|none|finalize` flags * Adds `--parts-out-dir=<crate specific directory>` for `--merge=none` to write cross-crate info file for a single crate * Adds `--include-parts-dir=<previously specified directory>` for `--merge=finalize` to write cross-crate info files * `tests/rustdoc/` tests for the new flags | ||||
| 2024-09-07 | rustdoc: use a single box to store Attributes and ItemKind | Michael Howell | -1/+1 | |
| 2024-09-07 | rfc#3662 changes under unstable flags | EtomicBomb | -84/+91 | |
| * All new functionality is under unstable options * Adds `--merge=shared|none|finalize` flags * Adds `--parts-out-dir=<crate specific directory>` for `--merge=none` to write cross-crate info file for a single crate * Adds `--include-parts-dir=<previously specified directory>` for `--merge=finalize` to write cross-crate info files * update tests/run-make/rustdoc-default-output/rmake.rs golden | ||||
| 2024-09-05 | Rollup merge of #120736 - notriddle:notriddle/toc, r=t-rustdoc | Matthias Krüger | -2/+4 | |
| rustdoc: add header map to the table of contents ## Summary Add header sections to the sidebar TOC. ### Preview  * http://notriddle.com/rustdoc-html-demo-9/toc/rust/std/index.html * http://notriddle.com/rustdoc-html-demo-9/toc/rust-derive-builder/derive_builder/index.html ## Motivation Some pages are very wordy, like these. | crate | word count | |--|--| | [std::option](https://doc.rust-lang.org/stable/std/option/index.html) | 2,138 | [derive_builder](https://docs.rs/derive_builder/0.13.0/derive_builder/index.html) | 2,403 | [tracing](https://docs.rs/tracing/0.1.40/tracing/index.html) | 3,912 | [regex](https://docs.rs/regex/1.10.3/regex/index.html) | 8,412 This kind of very long document is more navigable with a table of contents, like Wikipedia's or the one [GitHub recently added](https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/) for READMEs. In fact, the use case is so compelling, that it's been requested multiple times and implemented in an extension: * https://github.com/rust-lang/rust/issues/80858 * https://github.com/rust-lang/rust/issues/28056 * https://github.com/rust-lang/rust/issues/14475 * https://rust.extension.sh/#show-table-of-content (Some of these issues ask for more than this, so don’t close them.) It's also been implemented by hand in some crates, because the author really thought it was needed. Protip: for a more exhaustive list, run [`site:docs.rs table of contents`](https://duckduckgo.com/?t=ffab&q=site%3Adocs.rs+table+of+contents&ia=web), though some of them are false positives. * https://docs.rs/figment/0.10.14/figment/index.html#table-of-contents * https://docs.rs/csv/1.3.0/csv/tutorial/index.html#table-of-contents * https://docs.rs/axum/0.7.4/axum/response/index.html#table-of-contents * https://docs.rs/regex-automata/0.4.5/regex_automata/index.html#table-of-contents Unfortunately for these hand-built ToCs, because they're just part of the docs, there's no consistent way to turn them off if the reader doesn't want them. It's also more complicated to ensure they stay in sync with the docs they're supposed to describe, and they don't stay with you when you scroll like Wikipedia's [does now](https://uxdesign.cc/design-notes-on-the-2023-wikipedia-redesign-d6573b9af28d). ## Guide-level explanation When writing docs for a top-level item, the first and second level of headers will be shown in an outline in the sidebar. In this context, "top level" means "not associated". This means, if you're writing very long guides or explanations, and you want it to have a table of contents in the sidebar for its headings, the ideal place to attach it is usually the *module* or *crate*, because this page has fewer other things on it (and is the ideal place to describe "cross-cutting concerns" for its child items). If you're reading documentation, and want to get rid of the table of contents, open the  Settings panel and checkmark "Hide table of contents." ## Reference-level explanation Top-level items have an outline generated. This works for potentially-malformed header trees by pairing a header with the nearest header with a higher level. For example: ```markdown ## A # B # C ## D ## E ``` A, B, and C are all siblings, and D and E are children of C. Rustdoc only presents two layers of tree, but it tracks up to the full depth of 6 while preparing it. That means that these two doc comment both generate the same outline: ```rust /// # First /// ## Second struct One; /// ## First /// ### Second struct Two; ``` ## Drawbacks The biggest drawback is adding more stuff to the sidebar. My crawl through docs.rs shows this to, surprisingly, be less of a problem than I thought. The manually-built tables of contents, and the pages with dozens of headers, usually seem to be modules or crates, not types (where extreme scrolling would become a problem, since they already have methods to deal with). The best example of a type with many headers is [vec::Vec](https://doc.rust-lang.org/1.75.0/std/vec/struct.Vec.html), which still only has five headers, not dozens like [axum::extract](https://docs.rs/axum/0.7.4/axum/extract/index.html). ## Rationale and alternatives ### Why in the existing sidebar? The method links and the top-doc header links have more in common with each other than either of them do with the "In [parent module]" links, and should go together. ### Why limited to two levels? The sidebar is pretty narrow, and I don't want too much space used by indentation. Making the sidebar wider, while it has some upsides, also takes up more space on middling-sized screens or tiled WMs. ### Why not line wrap? That behaves strangely when resizing. ## Prior art ### Doc generators that have TOC for headers https://hexdocs.pm/phoenix/Phoenix.Controller.html is very close, in the sense that it also has header sections directly alongside functions and types. Another example, referenced as part of the [early sidebar discussion](https://github.com/rust-lang/rust/issues/37856) that added methods, Ruby will show a table of contents in the sidebar (for example, on the [ARGF](https://docs.ruby-lang.org/en/master/ARGF.html) class). According to their changelog, [they added it in 2013](https://github.com/ruby/rdoc/blob/06137bde8ccc48cd502bc28178bcd8f2dfe37624/History.rdoc#400--2013-02-24-). Haskell seems to mix text and functions even more freely than Elixir. For example, this [Naming conventions](https://hackage.haskell.org/package/base-4.19.0.0/docs/Control-Monad.html#g:3) is plain text, and is immediately followed by functions. And the [Pandoc top level](https://hackage.haskell.org/package/pandoc-3.1.11.1/docs/Text-Pandoc.html) has items split up by function, rather than by kind. Their TOC matches exactly with the contents of the page. ### Doc generators that don't have header TOC, but still have headers Elm, interestingly enough, seems to have the same setup that Rust used to have: sibling navigation between modules, and no index within a single page. [They keep Haskell's habit of named sections with machine-generated type signatures](https://package.elm-lang.org/packages/elm/browser/latest/Browser-Dom), though. [PHP](https://www.php.net/manual/en/book.datetime.php), like elm, also has a right-hand sidebar with sibling navigation. However, PHP has a single page for a single method, unlike Rust's page for an entire "class." So even though these pages have headers, it's never more than ten at most. And when they have guides, those guides are also multi-page. ## Unresolved questions * Writing recommendations for anyone who wants to take advantage of this. * Right now, it does not line wrap. That might be a bad idea: a lot of these are getting truncated. * Split sidebars, which I [tried implementing](https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/Table.20of.20contents), are not required. The TOC can be turned off, if it's really a problem. Implemented in https://github.com/rust-lang/rust/pull/120818, but needs more, separate, discussion. ## Future possibilities I would like to do a better job of distinguishing global navigation from local navigation. Rustdoc has a pretty reasonable information architecture, if only we did a better job of communicating it. This PR aims, mostly, to help doc authors help their users by writing docs that can be more effectively skimmed. But it doesn't do anything to make it easier to tell the TOC and the Module Nav apart. | ||||
| 2024-08-30 | Remove `#[macro_use] extern crate tracing` from rustdoc. | Nicholas Nethercote | -0/+1 | |
| 2024-08-20 | rustdoc: add test case for modnav position when TOC is off | Michael Howell | -5/+2 | |
| 2024-08-20 | rustdoc: add separate section for module items | Michael Howell | -3/+6 | |
| 2024-08-20 | Add configuration options to hide TOC or module navigation | Michael Howell | -0/+1 | |
| 2024-08-20 | Add Top TOC support to rustdoc | Michael Howell | -1/+2 | |
| This commit adds the headers for the top level documentation to rustdoc's existing table of contents, along with associated items. It only show two levels of headers. Going further would require the sidebar to be wider, and that seems unnecessary (the crates that have manually-built TOCs usually don't need deeply nested headers). | ||||
| 2024-08-07 | add blank line, remove extraneous comment | EtomicBomb | -1/+0 | |
| 2024-08-07 | initial implementation of mergable rustdoc cci | EtomicBomb | -8/+2 | |
| 2024-07-29 | Reformat `use` declarations. | Nicholas Nethercote | -8/+5 | |
| The previous commit updated `rustfmt.toml` appropriately. This commit is the outcome of running `x fmt --all` with the new formatting options. | ||||
| 2024-07-23 | Replace askama with rinja | Guillaume Gomez | -1/+1 | |
| 2024-04-18 | Simplify `static_assert_size`s. | Nicholas Nethercote | -1/+3 | |
| We want to run them on all 64-bit platforms. | ||||
| 2024-04-09 | rustdoc: load icons from css instead of inline | Michael Howell | -1/+1 | |
| This cuts the HTML overhead for a page by about 1KiB, significantly reducing the overall size of the docs bundle. | ||||
 |
index : rust | |
| https://github.com/rust-lang/rust |
| about summary refs log tree commit diff |