summaryrefslogtreecommitdiff
path: root/tools/docs.py
diff options
context:
space:
mode:
authorRyan Dahl <ry@tinyclouds.org>2018-11-14 09:38:42 -0500
committerRyan Dahl <ry@tinyclouds.org>2018-11-14 17:34:28 -0800
commit765863e87aea725301d5f528b6de15bfa6022d46 (patch)
treec47b8133be4e5de36c9ed2d686f57f90480e72b0 /tools/docs.py
parentfbaa40f6dcf67bf1113f3d4d8f600d2f73e01414 (diff)
Add a simple doc generation tool.
And website upload tool.
Diffstat (limited to 'tools/docs.py')
-rwxr-xr-xtools/docs.py26
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"
+])