Is there a way of forcing private items documentation on docs build?
It can be done manually adding the doc flag --document-private-items, but I would like to force it in Cargo.toml level for example.
Asked
Active
Viewed 124 times
3
Netwave
- 40,134
- 6
- 50
- 93
1 Answers
4
You can do this not with Cargo.toml but cargo's config. In your project (or in $CARGO_HOME if you want this to apply for all of your projects) create .cargo/config.toml with following contents:
[build]
rustdocflags = ["--document-private-items"]
Here is the link to the documentation.
Aleksander Krauze
- 3,115
- 7
- 18
-
1I always forget about the config file. That was exactly what I needed, thanks!! – Netwave Oct 26 '22 at 13:02
-
Actually somehow it doesn't work :S, tried with `cargo doc` and `cargo rustdoc`, seems like it do not read the flag. – Netwave Oct 26 '22 at 13:12
-
Are you sure you didn't typo? It worked for me. – Aleksander Krauze Oct 26 '22 at 13:14
-
tripel checked because I thought it was the case, but it was correct @_@ – Netwave Oct 26 '22 at 13:19
-
What version of `cargo` you have? Do you use any cargo related env variables? – Aleksander Krauze Oct 26 '22 at 13:22
-
`1.64.0`, I am setting some rustflags as well – Netwave Oct 26 '22 at 13:24
-
Does passing this flag with `$RUSTDOCFLAGS` work? – Aleksander Krauze Oct 26 '22 at 13:28
-
Let us [continue this discussion in chat](https://chat.stackoverflow.com/rooms/249072/discussion-between-netwave-and-aleksander-krauze). – Netwave Oct 26 '22 at 13:34