How to hide `automatically generated` documentation items

[bradbell]

The is a re-opening of the question

Rustdoc - how can I hide "automatically generated" items?

My crate documentation is full of annoying items (methods, sections, see below), which are unnecessary. There are two types of these: Auto Trait Implementations and Blanket Implementations Iterator methods (next_chunk(), size_hint() etc.) Derived methods(eq(), ne() etc.) I could hide the whole Iterator, but it's important that it's implemented, although listing all of its methods is just spam. I've found that the readers can configure some of these options for themselves, can I set a default…

Suppose my only source code is src/lib.rs (see below). If I run cargo doc I get a huge number of items below Auto Trait Implementations and Blanket Implementations . How to I suppress these automatically generate items ?

//! cargo_test documentation

/// MyInt documentation
pub struct MyInt {
   pub value : u32 ,
}
/// MyInt + MyInt documentation
impl std::ops::Add<MyInt> for MyInt {
   type Output = MyInt;
   fn add(self, rhs : MyInt) -> MyInt {
      MyInt {
         value : self.value + rhs.value,
      }
   }
}

[kpreid]

Auto trait implementations are sometimes absolutely necessary to understand how a library can be used (particularly when threads are involved). Even if you find a way to hide them, please do not.

[nerditation]

@bradbell

a huge number of items below Auto Trait Implementations and Blanket Implementations . How to I suppress these automatically generate items

first of all, these sections are placed at the last position, after the manual trait impls, in order to make them less intrusive. auto traits are all one-liners because they are marker traits, and the blanket impls are wrapped in <details> html tags and collapsed on load, so I don't think suppressing these sections makes a significant difference in terms of readability.

but if you insist, you can use css to hide them, it's just html after all. (I don't think you can prevent rustdoc from generating them, though).

there's an --extend-css command line option for this. this will append the custom css to all the theme css files. alternatively, you can also use a custom theme (with the --theme command line option), instead of modifying the existing ones, so you can toggle the visibility by simply switching themes.

however, the format of rustdoc output is undocumented, the relevant id and class of the html elements can only be found in the source code.

for example, the section of auto trait implementations and blanket implementations are rendered here:

src/librustdoc/html/render/mod.rs