docs(CLI): added Download information

That way, it's easy to obtain the respective precompiled binary, as
well as seeing the source-code.

Overall, it makes promoting the tools easier as the CLI docs can be
linked directly.

Closes #108
[skip ci]
This commit is contained in:
Sebastian Thiel
2015-05-10 19:40:25 +02:00
parent 9e64d1bd10
commit 383595c44e
4 changed files with 28 additions and 5 deletions

View File

@@ -17,7 +17,11 @@ make:
types:
- api
- cli
html_index:
# All known platforms we build for, using prettyfied, custom names
platforms:
- ubuntu
- osx
url_info:
download_base_url: http://dl.byronimo.de
asset_urls:
crates_img: https://raw.githubusercontent.com/rust-lang/crates.io/master/public/favicon.ico

View File

@@ -13,6 +13,15 @@ If data-structures are requested, these will be returned as pretty-printed JSON,
Everything else about the *discovery* API can be found at the
[official documentation site](https://developers.google.com/discovery/).
# Downloads
You can download the pre-compiled 64bit binaries for the following platforms:
* ![icon](http://megaicons.net/static/img/icons_sizes/6/140/16/ubuntu-icon.png) [ubuntu](http://dl.byronimo.de/google.rs/cli/0.2.0/ubuntu/discovery1.tar.gz)
* ![icon](http://hydra-media.cursecdn.com/wow.gamepedia.com/a/a2/Apple-icon-16x16.png?version=25ddd67ac3dd3b634478e3978b76cb74) [osx](http://dl.byronimo.de/google.rs/cli/0.2.0/osx/discovery1.tar.gz)
Find the source code [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/discovery1-cli).
# Usage
This documentation was generated from the *discovery* API at revision *00000000*. The CLI is at version *0.2.0*.

View File

@@ -1,5 +1,5 @@
<%
from util import (markdown_comment, new_context)
from util import (markdown_comment, new_context, program_download_url)
from cli import (CONFIG_DIR, CONFIG_DIR_FLAG, SCOPE_FLAG, application_secret_path, DEBUG_FLAG, DEBUG_AUTH_FLAG)
c = new_context(schemas, resources, context.get('methods'))
@@ -21,6 +21,16 @@ Everything else about the *${util.canonical_name()}* API can be found at the
[official documentation site](${documentationLink}).
% endif
# Downloads
You can download the pre-compiled 64bit binaries for the following platforms:
% for os_name in make.platforms:
* ![icon](${url_info.asset_urls.get('%s_img' % os_name)}) [${os_name}](${program_download_url(url_info.download_base_url, 'cli', cargo.build_version, os_name, name, version)})
% endfor
Find the source code [on github](${util.github_source_root_url()}).
# Usage
This documentation was generated from the *${util.canonical_name()}* API at revision *${revision is UNDEFINED and '00000000' or revision}*. The CLI is at version *${cargo.build_version}*.

View File

@@ -69,10 +69,10 @@ DO NOT EDIT !
<% ad = tc[program_type] %>
<a class="mod" href="${api_index(DOC_ROOT, an, v, ad.make)}" title="${ad.make.id.upper()} docs for the ${an} ${v}">${ad.make.id.upper()}</a>
% if program_type == 'api':
<a href="${crates_io_url(an, v)}"><img src="${html_index.asset_urls.crates_img}" title="This API on crates.io" height="16" width="16"/></a>
<a href="${crates_io_url(an, v)}"><img src="${url_info.asset_urls.crates_img}" title="This API on crates.io" height="16" width="16"/></a>
% else:
% for os_name in ('ubuntu', 'osx'):
<a href="${program_download_url(html_index.download_base_url, program_type, ad.cargo.build_version, os_name, an, v)}"><img src="${html_index.asset_urls.get('%s_img' % os_name)}" title="Download the pre-compiled 64bit program for ${os_name}" height="16" width="16"/></a>
% for os_name in make.platforms:
<a href="${program_download_url(url_info.download_base_url, program_type, ad.cargo.build_version, os_name, an, v)}"><img src="${url_info.asset_urls.get('%s_img' % os_name)}" title="Download the pre-compiled 64bit program for ${os_name}" height="16" width="16"/></a>
% endfor ## each os
% endif
% if not loop.last: