diff options
Diffstat (limited to 'tools/docs.py')
-rwxr-xr-x | tools/docs.py | 26 |
1 files changed, 26 insertions, 0 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" +]) |