summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBartek IwaƄczuk <biwanczuk@gmail.com>2020-05-16 16:02:03 +0200
committerGitHub <noreply@github.com>2020-05-16 16:02:03 +0200
commit6405675448917f36252cde52d8504a64b73db9c8 (patch)
treeeb89c88f45d8d278f69ea9478fcf875d95905853
parent0b9942da84bb9bfc9fc1eaf4170ad71864b7c179 (diff)
chore: remove typedoc (#5497)
-rw-r--r--README.md2
-rw-r--r--docs/examples/os_signals.md2
-rw-r--r--tools/README.md22
-rwxr-xr-xtools/docs.py21
-rwxr-xr-xtools/upload_docs.py13
5 files changed, 2 insertions, 58 deletions
diff --git a/README.md b/README.md
index 0c3f92a4d..3c75b55ad 100644
--- a/README.md
+++ b/README.md
@@ -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)
diff --git a/docs/examples/os_signals.md b/docs/examples/os_signals.md
index 7dfa6187d..7fbe8503b 100644
--- a/docs/examples/os_signals.md
+++ b/docs/examples/os_signals.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.
diff --git a/tools/README.md b/tools/README.md
index f8f93f0ec..cec1e39e8 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -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).
diff --git a/tools/docs.py b/tools/docs.py
deleted file mode 100755
index a1626b246..000000000
--- a/tools/docs.py
+++ /dev/null
@@ -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"
-])
diff --git a/tools/upload_docs.py b/tools/upload_docs.py
deleted file mode 100755
index 70605dd4a..000000000
--- a/tools/upload_docs.py
+++ /dev/null
@@ -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/"
-])