user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #44989 - QuietMisdreavus:what-is-your-quest, r=GuillaumeGomez

Browse source 
let rustdoc print the crate version into docs

This PR adds a new unstable flag to rustdoc, `--crate-version`, which when present will add a new entry to the sidebar of the root module, printing the given version number:

![Screenshot of a test crate, showing "Version 1.3.37" under the crate name](https://user-images.githubusercontent.com/5217170/31104096-805e3f4c-a7a0-11e7-96fc-368b6fe063d6.png)

Closes #24336

(The WIP status is because i don't want to merge this until i can get the std docs to use it, which i need help from rustbuild people to make sure i get right.)
This commit is contained in:
kennytm 2017-10-12 16:14:22 +08:00
commit 445bbde784
No known key found for this signature in database
GPG key ID: FEF6C8051D0E013C
7 changed files with 57 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/test/rustdoc/crate-version.rs Normal file
View file

@ -0,0 +1,13 @@
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
// compile-flags: --crate-version=1.3.37 -Z unstable-options
// @has 'crate_version/index.html' '//div[@class="block version"]/p' 'Version 1.3.37'