Stabilize --crate-version option in rustdoc
This commit is contained in:
parent
abc3073c92
commit
c57de34e8f
5 changed files with 14 additions and 19 deletions
|
@ -52,12 +52,7 @@ fn main() {
|
||||||
// Bootstrap's Cargo-command builder sets this variable to the current Rust version; let's pick
|
// Bootstrap's Cargo-command builder sets this variable to the current Rust version; let's pick
|
||||||
// it up so we can make rustdoc print this into the docs
|
// it up so we can make rustdoc print this into the docs
|
||||||
if let Some(version) = env::var_os("RUSTDOC_CRATE_VERSION") {
|
if let Some(version) = env::var_os("RUSTDOC_CRATE_VERSION") {
|
||||||
// This "unstable-options" can be removed when `--crate-version` is stabilized
|
|
||||||
if !has_unstable {
|
|
||||||
cmd.arg("-Z").arg("unstable-options");
|
|
||||||
}
|
|
||||||
cmd.arg("--crate-version").arg(version);
|
cmd.arg("--crate-version").arg(version);
|
||||||
has_unstable = true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Needed to be able to run all rustdoc tests.
|
// Needed to be able to run all rustdoc tests.
|
||||||
|
|
|
@ -390,3 +390,15 @@ the same CSS rules as the official `light` theme.
|
||||||
`--check-theme` is a separate mode in `rustdoc`. When `rustdoc` sees the
|
`--check-theme` is a separate mode in `rustdoc`. When `rustdoc` sees the
|
||||||
`--check-theme` flag, it discards all other flags and only performs the CSS rule
|
`--check-theme` flag, it discards all other flags and only performs the CSS rule
|
||||||
comparison operation.
|
comparison operation.
|
||||||
|
|
||||||
|
### `--crate-version`: control the crate version
|
||||||
|
|
||||||
|
Using this flag looks like this:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ rustdoc src/lib.rs --crate-version 1.3.37
|
||||||
|
```
|
||||||
|
|
||||||
|
When `rustdoc` receives this flag, it will print an extra "Version (version)" into the sidebar of
|
||||||
|
the crate root's docs. You can use this flag to differentiate between different versions of your
|
||||||
|
library's documentation.
|
||||||
|
|
|
@ -269,18 +269,6 @@ Markdown file, the URL given to `--markdown-playground-url` will take precedence
|
||||||
`--playground-url` and `#![doc(html_playground_url = "url")]` are present when rendering crate docs,
|
`--playground-url` and `#![doc(html_playground_url = "url")]` are present when rendering crate docs,
|
||||||
the attribute will take precedence.
|
the attribute will take precedence.
|
||||||
|
|
||||||
### `--crate-version`: control the crate version
|
|
||||||
|
|
||||||
Using this flag looks like this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ rustdoc src/lib.rs -Z unstable-options --crate-version 1.3.37
|
|
||||||
```
|
|
||||||
|
|
||||||
When `rustdoc` receives this flag, it will print an extra "Version (version)" into the sidebar of
|
|
||||||
the crate root's docs. You can use this flag to differentiate between different versions of your
|
|
||||||
library's documentation.
|
|
||||||
|
|
||||||
### `--sort-modules-by-appearance`: control how items on module pages are sorted
|
### `--sort-modules-by-appearance`: control how items on module pages are sorted
|
||||||
|
|
||||||
Using this flag looks like this:
|
Using this flag looks like this:
|
||||||
|
|
|
@ -266,7 +266,7 @@ fn opts() -> Vec<RustcOptGroup> {
|
||||||
unstable("display-warnings", |o| {
|
unstable("display-warnings", |o| {
|
||||||
o.optflag("", "display-warnings", "to print code warnings when testing doc")
|
o.optflag("", "display-warnings", "to print code warnings when testing doc")
|
||||||
}),
|
}),
|
||||||
unstable("crate-version", |o| {
|
stable("crate-version", |o| {
|
||||||
o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
|
o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
|
||||||
}),
|
}),
|
||||||
unstable("sort-modules-by-appearance", |o| {
|
unstable("sort-modules-by-appearance", |o| {
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
// compile-flags: --crate-version=1.3.37 -Z unstable-options
|
// compile-flags: --crate-version=1.3.37
|
||||||
|
|
||||||
// @has 'crate_version/index.html' '//div[@class="block version"]/p' 'Version 1.3.37'
|
// @has 'crate_version/index.html' '//div[@class="block version"]/p' 'Version 1.3.37'
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue