doc_file 0.1.0

Move your Rust crate's documentation into external files. 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# doc_file

[![Build Status][travis-img]][travis]

Move your Rust crate's documentation into external files.

## Why?

This is a proof of concept implementation of [rust-lang/rust#15470][issue].
I hope to iron out questions and discover issues out of tree and then
contribute this back to `rustc` itself.

## Example usage

```rust
#![feature(phase)]

// Paths are relative to the source file.
#![doc(file="example_crate.markdown")]

#[phase(plugin)] extern crate doc_file;

#[doc(file="complicated_thing.markdown")]
pub struct ComplicatedThing;

/// Document other items like usual
pub struct SimpleThing;
```

[travis]: https://travis-ci.org/tomjakubowski/doc_file
[travis-img]: https://travis-ci.org/tomjakubowski/doc_file.svg
[issue]: https://github.com/rust-lang/rust/issues/15470