jade/blog
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update the status of the Cargo PR

Browse source
This commit is contained in:
Jade 2021-07-03 20:24:04 -07:00
parent 0873fc3a2b
commit df71e76fd5
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
content/posts/docs-tricks-and-gnus.md
View file

@ -36,11 +36,10 @@ I do the usual routine with `cargo doc` in a project, which will generate docs
with links between libraries and the exact right versions of dependencies. with links between libraries and the exact right versions of dependencies.
However, there are some ways I've improved my experience: However, there are some ways I've improved my experience:
* I wrote [a shim script](https://github.com/lf-/dotfiles/blob/9c2ae57c98915ed3a3b089aae442702afad16660/bin/_cargo_doc_open) * I wrote [a shim script](https://github.com/lf-/dotfiles/blob/91c41202b42580a94fb3943e87f4b5785bdc9e65/bin/_cargo_doc_open)
that symlinks docs pages into the web root then opens them in a browser. The that symlinks docs pages into the web root then opens them in a browser. The
idea is that it can be set as `BROWSER` for `cargo` (there is a [PR idea is that it can be set as `BROWSER` for `cargo` using the `[doc].browser`
outstanding](https://github.com/rust-lang/cargo/pull/9473) for making browser Cargo config setting I added, releasing in Rust 1.54 (to release July 29 2021).
into a `cargo doc` config option).
* Use the `--document-private-items` option and maybe even * Use the `--document-private-items` option and maybe even
`RUSTDOCFLAGS='--document-hidden-items' cargo +nightly doc` `RUSTDOCFLAGS='--document-hidden-items' cargo +nightly doc`
in order to build documentation with the fun stuff visible, which is really in order to build documentation with the fun stuff visible, which is really