mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
rust/src/librustdoc/markdown.rs

148 lines
4.5 KiB
Rust
Raw Normal View History

rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
// Copyright 2014 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.
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 03:35:25 -07:00
use std::io;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
rustdoc: Add an --extern flag analagous to rustc's This adds an `--extern` flag to `rustdoc` much like the compiler's to specify the path where a given crate can be found.
2014-07-19 23:02:14 -07:00
use core;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
use getopts;
use testing;
rustc: Add knowledge of separate lookup paths This commit adds support for the compiler to distinguish between different forms of lookup paths in the compiler itself. Issue #19767 has some background on this topic, as well as some sample bugs which can occur if these lookup paths are not separated. This commits extends the existing command line flag `-L` with the same trailing syntax as the `-l` flag. Each argument to `-L` can now have a trailing `:all`, `:native`, `:crate`, or `:dependency`. This suffix indicates what form of lookup path the compiler should add the argument to. The `dependency` lookup path is used when looking up crate dependencies, the `crate` lookup path is used when looking for immediate dependencies (`extern crate` statements), and the `native` lookup path is used for probing for native libraries to insert into rlibs. Paths with `all` are used for all of these purposes (the default). The default compiler lookup path (the rustlib libdir) is by default added to all of these paths. Additionally, the `RUST_PATH` lookup path is added to all of these paths. Closes #19767
2014-12-16 14:32:02 -08:00
use rustc::session::search_paths::SearchPaths;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 03:35:25 -07:00
use externalfiles::ExternalHtml;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
use html::escape::Escape;
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 09:12:18 -07:00
use html::markdown;
rustdoc: make table of contents optional rustdoc currently determines whether to produce a table of contents (along with numbered sections) from the input type: yes for markdown input, no for Rust input. This commit adds a flag to disable the table of contents for markdown input, which is useful for embedding the output in a larger context.
2014-07-23 15:43:03 -07:00
use html::markdown::{Markdown, MarkdownWithToc, find_testable_code, reset_headers};
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
use test::Collector;
/// Separate any lines at the start of the file that begin with `%`.
fn extract_leading_metadata<'a>(s: &'a str) -> (Vec<&'a str>, &'a str) {
let mut metadata = Vec::new();
for line in s.lines() {
if line.starts_with("%") {
// remove %<whitespace>
metadata.push(line.slice_from(1).trim_left())
} else {
let line_start_byte = s.subslice_offset(line);
return (metadata, s.slice_from(line_start_byte));
}
}
// if we're here, then all lines were metadata % lines.
(metadata, "")
}
/// Render `input` (e.g. "foo.md") into an HTML file in `output`
/// (e.g. output = "bar" => "bar/foo.html").
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 03:35:25 -07:00
pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
rustdoc: make table of contents optional rustdoc currently determines whether to produce a table of contents (along with numbered sections) from the input type: yes for markdown input, no for Rust input. This commit adds a flag to disable the table of contents for markdown input, which is useful for embedding the output in a larger context.
2014-07-23 15:43:03 -07:00
external_html: &ExternalHtml, include_toc: bool) -> int {
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
let input_p = Path::new(input);
output.push(input_p.filestem().unwrap());
output.set_extension("html");
core: rename strbuf::StrBuf to string::String [breaking-change]
2014-05-22 16:57:53 -07:00
let mut css = String::new();
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
for name in matches.opt_strs("markdown-css").iter() {
let s = format!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{}\">\n", name);
libstd: Remove `~str` from all `libstd` modules except `fmt` and `str`.
2014-05-16 10:45:16 -07:00
css.push_str(s.as_slice())
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
}
let input_str = load_or_return!(input, 1, 2);
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 09:12:18 -07:00
let playground = matches.opt_str("markdown-playground-url");
if playground.is_some() {
std: Add a new top-level thread_local module This commit removes the `std::local_data` module in favor of a new `std::thread_local` module providing thread local storage. The module provides two variants of TLS: one which owns its contents and one which is based on scoped references. Each implementation has pros and cons listed in the documentation. Both flavors have accessors through a function called `with` which yield a reference to a closure provided. Both flavors also panic if a reference cannot be yielded and provide a function to test whether an access would panic or not. This is an implementation of [RFC 461][rfc] and full details can be found in that RFC. This is a breaking change due to the removal of the `std::local_data` module. All users can migrate to the new thread local system like so: thread_local!(static FOO: Rc<RefCell<Option<T>>> = Rc::new(RefCell::new(None))) The old `local_data` module inherently contained the `Rc<RefCell<Option<T>>>` as an implementation detail which must now be explicitly stated by users. [rfc]: https://github.com/rust-lang/rfcs/pull/461 [breaking-change]
2014-11-14 14:20:57 -08:00
markdown::PLAYGROUND_KRATE.with(|s| { *s.borrow_mut() = None; });
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 09:12:18 -07:00
}
let playground = playground.unwrap_or("".to_string());
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
let mut out = match io::File::create(&output) {
Err(e) => {
let _ = writeln!(&mut io::stderr(),
"error opening `{}` for writing: {}",
output.display(), e);
return 4;
}
Ok(f) => f
};
librustdoc: Remove all `~str` usage from librustdoc.
2014-05-12 13:44:59 -07:00
let (metadata, text) = extract_leading_metadata(input_str.as_slice());
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
if metadata.len() == 0 {
let _ = writeln!(&mut io::stderr(),
"invalid markdown file: expecting initial line with `% ...TITLE...`");
return 5;
}
deprecate Vec::get
2014-07-15 11:37:25 +12:00
let title = metadata[0].as_slice();
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
reset_headers();
rustdoc: make table of contents optional rustdoc currently determines whether to produce a table of contents (along with numbered sections) from the input type: yes for markdown input, no for Rust input. This commit adds a flag to disable the table of contents for markdown input, which is useful for embedding the output in a larger context.
2014-07-23 15:43:03 -07:00
let rendered = if include_toc {
format!("{}", MarkdownWithToc(text))
} else {
format!("{}", Markdown(text))
};
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
let err = write!(
&mut out,
doc: CSS fixes - fixup and refactor highlighting code - have a proper print stylesheet
2014-03-09 12:29:25 +01:00
r#"<!DOCTYPE html>
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="generator" content="rustdoc">
<title>{title}</title>
{css}
{in_header}
</head>
rustdoc: Add rustdoc class to <body> tag This allows for easier application of user stylesheets to rustdocs no matter where they are hosted.
2014-08-02 18:20:27 -07:00
<body class="rustdoc">
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
{before_content}
<h1 class="title">{title}</h1>
{text}
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 09:12:18 -07:00
<script type="text/javascript">
window.playgroundUrl = "{playground}";
</script>
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
{after_content}
</body>
</html>"#,
title = Escape(title),
css = css,
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 03:35:25 -07:00
in_header = external_html.in_header,
before_content = external_html.before_content,
rustdoc: make table of contents optional rustdoc currently determines whether to produce a table of contents (along with numbered sections) from the input type: yes for markdown input, no for Rust input. This commit adds a flag to disable the table of contents for markdown input, which is useful for embedding the output in a larger context.
2014-07-23 15:43:03 -07:00
text = rendered,
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 03:35:25 -07:00
after_content = external_html.after_content,
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 09:12:18 -07:00
playground = playground,
);
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
match err {
Err(e) => {
let _ = writeln!(&mut io::stderr(),
"error writing to `{}`: {}",
output.display(), e);
6
}
Ok(_) => 0
}
}
/// Run any tests/code examples in the markdown file `input`.
rustc: Add knowledge of separate lookup paths This commit adds support for the compiler to distinguish between different forms of lookup paths in the compiler itself. Issue #19767 has some background on this topic, as well as some sample bugs which can occur if these lookup paths are not separated. This commits extends the existing command line flag `-L` with the same trailing syntax as the `-l` flag. Each argument to `-L` can now have a trailing `:all`, `:native`, `:crate`, or `:dependency`. This suffix indicates what form of lookup path the compiler should add the argument to. The `dependency` lookup path is used when looking up crate dependencies, the `crate` lookup path is used when looking for immediate dependencies (`extern crate` statements), and the `native` lookup path is used for probing for native libraries to insert into rlibs. Paths with `all` are used for all of these purposes (the default). The default compiler lookup path (the rustlib libdir) is by default added to all of these paths. Additionally, the `RUST_PATH` lookup path is added to all of these paths. Closes #19767
2014-12-16 14:32:02 -08:00
pub fn test(input: &str, libs: SearchPaths, externs: core::Externs,
rustdoc: Add an --extern flag analagous to rustc's This adds an `--extern` flag to `rustdoc` much like the compiler's to specify the path where a given crate can be found.
2014-07-19 23:02:14 -07:00
mut test_args: Vec<String>) -> int {
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
let input_str = load_or_return!(input, 1, 2);
rustdoc: Add an --extern flag analagous to rustc's This adds an `--extern` flag to `rustdoc` much like the compiler's to specify the path where a given crate can be found.
2014-07-19 23:02:14 -07:00
let mut collector = Collector::new(input.to_string(), libs, externs, true);
librustdoc: Remove all `~str` usage from librustdoc.
2014-05-12 13:44:59 -07:00
find_testable_code(input_str.as_slice(), &mut collector);
collections: Deprecate shift/unshift Use insert/remove instead.
2014-07-14 13:54:10 -07:00
test_args.insert(0, "rustdoctest".to_string());
libtest: Remove all uses of `~str` from `libtest`.
2014-05-13 16:44:05 -07:00
testing::test_main(test_args.as_slice(), collector.tests);
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-07 14:31:41 +11:00
0
}
Reference in New Issue Copy Permalink