mirror of
https://github.com/denoland/deno.git
synced 2025-09-26 20:29:11 +00:00
Add a simple doc generation tool.
And website upload tool.
This commit is contained in:
parent
fbaa40f6dc
commit
765863e87a
6 changed files with 58 additions and 2 deletions
26
tools/docs.py
Executable file
26
tools/docs.py
Executable file
|
@ -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"
|
||||
])
|
Loading…
Add table
Add a link
Reference in a new issue