diff options
| author | bors <bors@rust-lang.org> | 2013-09-21 00:16:02 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2013-09-21 00:16:02 -0700 |
| commit | db78fdc10c0cf6c02005c0b8daefe9cf47aa806f (patch) | |
| tree | f4fbec72401b8656aa39d7fa8d8869f69b852907 /src/libstd | |
| parent | e268c7fcc58593d71962a49a147c21edfa702f20 (diff) | |
| parent | 4fd061c426902b0904c65e64a3780b21f9ab3afb (diff) | |
| download | rust-db78fdc10c0cf6c02005c0b8daefe9cf47aa806f.tar.gz rust-db78fdc10c0cf6c02005c0b8daefe9cf47aa806f.zip | |
auto merge of #9374 : alexcrichton/rust/rustdoc-web, r=cmr
This large commit implements and `html` output option for rustdoc_ng. The executable has been altered to be invoked as "rustdoc_ng html <crate>" and it will dump everything into the local "doc" directory. JSON can still be generated by changing 'html' to 'json'. This also fixes a number of bugs in rustdoc_ng relating to comment stripping, along with some other various issues that I found along the way. The `make doc` command has been altered to generate the new documentation into the `doc/ng/$(CRATE)` directories. Previews * http://www.contrib.andrew.cmu.edu/~acrichto/doc/std/ * http://www.contrib.andrew.cmu.edu/~acrichto/doc/extra/ Missing features * Different versions of documentation on the same page (all possibly indexed as well?) I think that this needs to be thought out before action is taken. It's an awesome idea, but it should be done carefully. * Source links are missing. This is a little dependent on getting versions working. In theory we should link back to github, but we should always link back to the exact version the documentation was generated from. * Integration with other tools. It would be awesome to have rustpkg-style inference of the package name and version so they don't have to be specified anywhere. Additionally, I should be able to build documentation for a pkgid, not necessarily a crate file. cc @cmr/@Seldaek
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/macros.rs | 1 | ||||
| -rw-r--r-- | src/libstd/num/int_macros.rs | 1 | ||||
| -rw-r--r-- | src/libstd/num/uint_macros.rs | 1 | ||||
| -rw-r--r-- | src/libstd/rt/mod.rs | 3 | ||||
| -rw-r--r-- | src/libstd/std.rs | 4 |
5 files changed, 9 insertions, 1 deletions
diff --git a/src/libstd/macros.rs b/src/libstd/macros.rs index 5378a2c798d..d72494b6255 100644 --- a/src/libstd/macros.rs +++ b/src/libstd/macros.rs @@ -9,6 +9,7 @@ // except according to those terms. #[macro_escape]; +#[doc(hidden)]; macro_rules! rterrln ( ($( $arg:expr),+) => ( { diff --git a/src/libstd/num/int_macros.rs b/src/libstd/num/int_macros.rs index 3a43c3364c6..ba8beeba4f6 100644 --- a/src/libstd/num/int_macros.rs +++ b/src/libstd/num/int_macros.rs @@ -11,6 +11,7 @@ // FIXME(#4375): this shouldn't have to be a nested module named 'generated' #[macro_escape]; +#[doc(hidden)]; macro_rules! int_module (($T:ty, $bits:expr) => (mod generated { diff --git a/src/libstd/num/uint_macros.rs b/src/libstd/num/uint_macros.rs index 7cd1be7ab74..45280482b87 100644 --- a/src/libstd/num/uint_macros.rs +++ b/src/libstd/num/uint_macros.rs @@ -11,6 +11,7 @@ // FIXME(#4375): this shouldn't have to be a nested module named 'generated' #[macro_escape]; +#[doc(hidden)]; macro_rules! uint_module (($T:ty, $T_SIGNED:ty, $bits:expr) => (mod generated { diff --git a/src/libstd/rt/mod.rs b/src/libstd/rt/mod.rs index 6df857b8d55..df59e5538b4 100644 --- a/src/libstd/rt/mod.rs +++ b/src/libstd/rt/mod.rs @@ -54,7 +54,8 @@ Several modules in `core` are clients of `rt`: */ -#[doc(hidden)]; +// XXX: this should not be here. +#[allow(missing_doc)]; use cell::Cell; use clone::Clone; diff --git a/src/libstd/std.rs b/src/libstd/std.rs index e9d5dd416ad..8dcb7d8cd04 100644 --- a/src/libstd/std.rs +++ b/src/libstd/std.rs @@ -57,6 +57,10 @@ they contained the following prologue: #[license = "MIT/ASL2"]; #[crate_type = "lib"]; +#[doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk.png", + html_favicon_url = "http://www.rust-lang.org/favicon.ico", + passes = "strip-hidden")]; + // Don't link to std. We are std. #[no_std]; |
