summaryrefslogtreecommitdiff
path: root/tools/docs.py
blob: bbc06877c2691c872dd9cd00399ca9637ac66d50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#!/usr/bin/env python
# Copyright 2018-2019 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", "--all", "--no-deps", "-vv"])

# 'deno --types' is stored in target/debug/gen/cli/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/cli/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"
])