doc(lib): use docs.rs for library documentation

We will still need to host the CLI docs though.
This commit is contained in:
Sebastian Thiel
2016-12-24 10:35:48 +01:00
parent 684233ccee
commit fc34337ee4
8 changed files with 17 additions and 8 deletions

View File

@@ -83,9 +83,9 @@ Configuration:
<%def name="new(c)" buffered="True">\
<%
doc_url_base = cargo.doc_base_url + '/' + os.path.dirname(api_index(cargo.doc_base_url, name,
doc_base_url = cargo.doc_base_url + '/' + os.path.dirname(api_index(cargo.doc_base_url, name,
version, make, check_exists=False))
url_info = "All documentation details can be found at " + doc_url_base
url_info = "All documentation details can be found at " + doc_base_url
# list of tuples
# (0) = long name
@@ -215,7 +215,7 @@ let arg_data = [
%>\
("${mangle_subcommand(method)}",
${rust_optional(mc.m.get('description'))},
"Details at ${doc_url_base}/${os.path.splitext(subcommand_md_filename(resource, method))[0]}",
"Details at ${doc_base_url}/${os.path.splitext(subcommand_md_filename(resource, method))[0]}",
vec![
% for flag, desc, arg_name, required, multi in args:
(${rust_optional(arg_name)},

View File

@@ -7,7 +7,7 @@
<%namespace name="util" file="../lib/util.mako"/>\
site_name: ${util.canonical_name()} v${util.crate_version()}
site_url: ${cargo.doc_base_url}/${util.crate_name()}
site_description: Write integrating applications with bcore
site_description: A complete library to interact with ${util.canonical_name()} (protocol ${version})
repo_url: ${util.github_source_root_url()}