diff options
author | Ryan Dahl <ry@tinyclouds.org> | 2018-11-14 09:38:42 -0500 |
---|---|---|
committer | Ryan Dahl <ry@tinyclouds.org> | 2018-11-14 17:34:28 -0800 |
commit | 765863e87aea725301d5f528b6de15bfa6022d46 (patch) | |
tree | c47b8133be4e5de36c9ed2d686f57f90480e72b0 | |
parent | fbaa40f6dcf67bf1113f3d4d8f600d2f73e01414 (diff) |
Add a simple doc generation tool.
And website upload tool.
-rwxr-xr-x | tools/docs.py | 26 | ||||
-rwxr-xr-x | tools/upload_website.py | 18 | ||||
-rw-r--r-- | website/app.js | 7 | ||||
-rw-r--r-- | website/index.html | 7 | ||||
l--------- | website/rustdoc | 1 | ||||
l--------- | website/typedoc | 1 |
6 files changed, 58 insertions, 2 deletions
diff --git a/tools/docs.py b/tools/docs.py new file mode 100755 index 000000000..00efd22c5 --- /dev/null +++ b/tools/docs.py @@ -0,0 +1,26 @@ +#!/usr/bin/env python +# Copyright 2018 the Deno authors. All rights reserved. MIT license. +import os +import tempfile +from util import run, root_path + +target_path = os.path.join(root_path, "target/") + +os.chdir(root_path) + +# Builds into target/doc +run(["cargo", "doc", "--no-deps", "-vv"]) + +# 'deno --types' is stored in target/debug/gen/lib/lib.deno_runtime.d.ts +# We want to run typedoc on that declaration file only. +os.chdir(os.path.join(target_path, "debug/gen/lib/")) + +# You must have typedoc installed seprately. +# TODO Replace typedoc with something else ASAP. It's very awful. +run([ + "typedoc", "lib.deno_runtime.d.ts", "--out", + os.path.join(target_path, "typedoc"), "--entryPoint", "\"deno\"", + "--ignoreCompilerErrors", "--includeDeclarations", "--excludeExternals", + "--excludePrivate", "--excludeProtected", "--mode", "file", "--name", + "deno", "--theme", "minimal", "--readme", "none" +]) diff --git a/tools/upload_website.py b/tools/upload_website.py new file mode 100755 index 000000000..5153d35aa --- /dev/null +++ b/tools/upload_website.py @@ -0,0 +1,18 @@ +#!/usr/bin/env python +# Copyright 2018 the Deno authors. All rights reserved. MIT license. +import os +import tempfile +from util import run, root_path + +# Probably run tools/docs.py first. +# AWS CLI must be installed separately. + +os.chdir(os.path.join(root_path, "website")) + +# Invalidate the cache. +run([ + "aws", "cloudfront", "create-invalidation", "--distribution-id", + "E3NZSZMS5TZ0OU", "--paths", "/*" +]) + +run(["aws", "s3", "sync", ".", "s3://deno.land/"]) diff --git a/website/app.js b/website/app.js index 6bf5194b1..d3b90b297 100644 --- a/website/app.js +++ b/website/app.js @@ -182,6 +182,13 @@ function formatSecsAsMins(t) { * @param dataUrl The url of benchramk data json. */ export function drawCharts(dataUrl) { + // TODO Using window["location"]["hostname"] instead of + // window.location.hostname because when deno runs app_test.js it gets a type + // error here, not knowing about window.location. Ideally Deno would skip + // type check entirely on JS files. + if (window["location"]["hostname"] != "deno.github.io") { + dataUrl = "https://denoland.github.io/deno/" + dataUrl; + } drawChartsFromBenchmarkData(dataUrl); drawChartsFromTravisData(); } diff --git a/website/index.html b/website/index.html index b5357b691..f56a312ee 100644 --- a/website/index.html +++ b/website/index.html @@ -13,7 +13,9 @@ <p> <a href="https://github.com/denoland/deno">github.com/denoland/deno</a> - <p> <a href="https://github.com/denoland/deno/blob/master/Docs.md">Docs</a> + <p> <a href="https://github.com/denoland/deno/blob/master/Docs.md">Intro</a> + <p> <a href="typedoc/index.html">TypeScript API</a> + <p> <a href="rustdoc/deno/index.html">Rust API</a> <h2>Execution time</h2> This shows how much time total it takes to run a few simple deno programs: @@ -58,7 +60,8 @@ <script type="module"> import { drawCharts } from "./app.js"; - drawCharts("./recent.json"); + + drawCharts("recent.json"); </script> </body> </html> diff --git a/website/rustdoc b/website/rustdoc new file mode 120000 index 000000000..91ebb25e2 --- /dev/null +++ b/website/rustdoc @@ -0,0 +1 @@ +../target/doc/
\ No newline at end of file diff --git a/website/typedoc b/website/typedoc new file mode 120000 index 000000000..eba22d9ca --- /dev/null +++ b/website/typedoc @@ -0,0 +1 @@ +../target/typedoc/
\ No newline at end of file |