Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rollup of 9 pull requests #123484

Merged
merged 23 commits into from
Apr 5, 2024
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
8f5a28e
Require Pointee::Metadata to be Freeze
stepancheg Mar 29, 2024
2edc54c
Default to light theme is JS is enabled but not working
GuillaumeGomez Apr 3, 2024
8f9d93b
Add GUI test to ensure there is always a theme applied if JS is disabled
GuillaumeGomez Apr 3, 2024
2815edc
Update `rustdoc_css_themes.rs` to take into account new selectors
GuillaumeGomez Apr 3, 2024
f6b97ef
Manually run `clang-format` on `CoverageMappingWrapper.cpp`
Zalathar Apr 3, 2024
d99c775
unconstrained `NormalizesTo` term for opaques
lcnr Apr 2, 2024
92b280c
normalizes-to change from '1' to '0 to inf' steps
lcnr Apr 2, 2024
17475de
hir: Use `ItemLocalId` in a couple more places
petrochenkov Apr 4, 2024
612acf8
rustdoc prioritise cargo doc: suggestions applied
harryhanYuhao Apr 4, 2024
6f17b7f
Rename HAS_PROJECTIONS to HAS_ALIASES etc.
fmease Apr 4, 2024
f2ff9c9
Update browser-ui-test version to 0.17.1
GuillaumeGomez Apr 4, 2024
a815b97
Add regression test to ensure that even if JS is enabled but not work…
GuillaumeGomez Apr 4, 2024
9444ca3
do not ICE in forced ambiguity if we get an error
lcnr Apr 4, 2024
b53a0f2
CFI: Add test for `call_once` addr taken
maurer Apr 4, 2024
de2cb0d
Rollup merge of #123206 - stepancheg:pointee-metadata-freeze, r=Amanieu
jhpratt Apr 5, 2024
fcb0e9d
Rollup merge of #123363 - lcnr:normalizes-to-zero-to-inf, r=BoxyUwU
jhpratt Apr 5, 2024
ac29872
Rollup merge of #123407 - GuillaumeGomez:js-failed-theme, r=notriddle
jhpratt Apr 5, 2024
50603cb
Rollup merge of #123417 - harryhanYuhao:master, r=GuillaumeGomez
jhpratt Apr 5, 2024
daef0fd
Rollup merge of #123437 - Zalathar:clang-format, r=cuviper
jhpratt Apr 5, 2024
929e0db
Rollup merge of #123454 - petrochenkov:zeroindex2, r=fmease
jhpratt Apr 5, 2024
58eb6e5
Rollup merge of #123464 - fmease:rn-has-proj-to-has-aliases, r=compil…
jhpratt Apr 5, 2024
e01d3e0
Rollup merge of #123477 - lcnr:forced_ambig-no-ice, r=compiler-errors
jhpratt Apr 5, 2024
e8b0c30
Rollup merge of #123478 - maurer:cfi-call-once-addr-taken, r=compiler…
jhpratt Apr 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
rustdoc prioritise cargo doc: suggestions applied
harryhanYuhao committed Apr 4, 2024
commit 612acf8397f0f8d55fc533d61ea835b73a1e696d
11 changes: 10 additions & 1 deletion src/doc/rustdoc/src/what-is-rustdoc.md
Original file line number Diff line number Diff line change
@@ -34,6 +34,9 @@ the main page is located in `doc/lib/index.html`. If you open that up in
a web browser, you will see a page with a search bar, and "Crate lib" at the
top, with no contents.

You can also use `cargo doc` to generate documentation for the whole project.
See [Using rustdoc with Cargo](#using-rustdoc-with-cargo).

## Configuring rustdoc

There are two problems with this: first, why does it
@@ -79,7 +82,13 @@ docs. Instead of the `rustdoc` command, we could have done this:
$ cargo doc
```

Internally, this calls out to `rustdoc` like this:
If you want `cargo` to automatically open the generated documentation, you can use:

```bash
$ cargo doc --open
```

Internally, `cargo doc` calls out to `rustdoc` like this:

```bash
$ rustdoc --crate-name docs src/lib.rs -o <path>/docs/target/doc -L