mirror of
https://github.com/denoland/deno.git
synced 2024-11-28 16:20:57 -05:00
chore: remove typedoc (#5497)
This commit is contained in:
parent
0b9942da84
commit
6405675448
5 changed files with 2 additions and 58 deletions
|
@ -16,7 +16,7 @@ specifics.
|
|||
|
||||
[Install](https://github.com/denoland/deno_install)
|
||||
|
||||
[API Reference](https://deno.land/typedoc/)
|
||||
[API Reference](https://doc.deno.land)
|
||||
|
||||
[Style Guide](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
> This program makes use of an unstable Deno feature. Learn more about
|
||||
> [unstable features](../runtime/stability.md).
|
||||
|
||||
[API Reference](https://deno.land/typedoc/index.html#signal)
|
||||
[API Reference](https://doc.deno.land/https/raw.githubusercontent.com/denoland/deno/master/cli/js/lib.deno.unstable.d.ts#Deno.signal)
|
||||
|
||||
You can use `Deno.signal()` function for handling OS signals.
|
||||
|
||||
|
|
|
@ -2,28 +2,6 @@
|
|||
|
||||
Documentation for various tooling in support of Deno development
|
||||
|
||||
## docs.py
|
||||
|
||||
This script is used to generate the API documentation for Deno. It can be useful
|
||||
to run locally to test the formatting of your changes to the documentation.
|
||||
|
||||
If you would like to see how your JSDoc will be rendered after changing
|
||||
`cli/js/lib.deno.ns.d.ts`, you can run the following:
|
||||
|
||||
First, make sure you have typedoc installed:
|
||||
|
||||
```bash
|
||||
npm install typedoc --save-dev
|
||||
```
|
||||
|
||||
Then run the doc generation tool:
|
||||
|
||||
```bash
|
||||
./tools/docs.py
|
||||
```
|
||||
|
||||
Output can be found in `./target/typedoc/index.html`
|
||||
|
||||
## format.py
|
||||
|
||||
This script will format the code (currently using prettier, yapf and rustfmt).
|
||||
|
|
|
@ -1,21 +0,0 @@
|
|||
#!/usr/bin/env python
|
||||
# Copyright 2018-2020 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/")
|
||||
|
||||
# 'deno types' is stored in js/lib.deno_runtime.d.ts
|
||||
# We want to run typedoc on that declaration file only.
|
||||
os.chdir(os.path.join(root_path, "cli/js"))
|
||||
|
||||
# You must have typedoc installed seprately.
|
||||
# TODO Replace typedoc with something else ASAP. It's very awful.
|
||||
run([
|
||||
"typedoc", "lib.deno.ns.d.ts", "--out",
|
||||
os.path.join(target_path, "typedoc"), "--entryPoint", "Deno",
|
||||
"--ignoreCompilerErrors", "--includeDeclarations", "--excludeExternals",
|
||||
"--excludePrivate", "--excludeProtected", "--mode", "file", "--name",
|
||||
"deno", "--theme", "minimal", "--readme", "none"
|
||||
])
|
|
@ -1,13 +0,0 @@
|
|||
#!/usr/bin/env python
|
||||
# Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
|
||||
import os
|
||||
import sys
|
||||
from util import run, root_path
|
||||
|
||||
os.chdir(root_path)
|
||||
run([sys.executable, "tools/docs.py"])
|
||||
os.chdir("target")
|
||||
run([
|
||||
"aws", "s3", "sync", "--include=typedoc", "--exclude=debug/*",
|
||||
"--exclude=package/*", "--exclude=release/*", ".", "s3://deno.land/"
|
||||
])
|
Loading…
Reference in a new issue