#plugin

nightly doc_file

Move your Rust crate's documentation into external files

4 releases (2 breaking)

Uses old Rust 2015

0.2.0 Dec 19, 2014
0.1.0 Dec 11, 2014
0.0.2 Dec 9, 2014
0.0.1 Dec 8, 2014

#110 in #plugin

MIT license

5KB
87 lines

doc_file

Build Status

Move your Rust crate's documentation into external files.

Why?

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

Example usage

#![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;

Open issues

The syntax #[doc_file = "..."] is a little ugly. Ideally it would be something like #[doc(file = "...")].

No runtime deps