Skip to content

Commit

Permalink
chore: remove typedoc (denoland#5497)
Browse files Browse the repository at this point in the history
  • Loading branch information
bartlomieju committed May 16, 2020
1 parent 0b9942d commit 6405675
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 58 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/os_signals.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
22 changes: 0 additions & 22 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
21 changes: 0 additions & 21 deletions tools/docs.py

This file was deleted.

13 changes: 0 additions & 13 deletions tools/upload_docs.py

This file was deleted.

0 comments on commit 6405675

Please sign in to comment.