diff options
| author | Bartek Iwańczuk <biwanczuk@gmail.com> | 2020-05-16 16:02:03 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-16 16:02:03 +0200 |
| commit | 6405675448917f36252cde52d8504a64b73db9c8 (patch) | |
| tree | eb89c88f45d8d278f69ea9478fcf875d95905853 /tools/README.md | |
| parent | 0b9942da84bb9bfc9fc1eaf4170ad71864b7c179 (diff) | |
chore: remove typedoc (#5497)
Diffstat (limited to 'tools/README.md')
| -rw-r--r-- | tools/README.md | 22 |
1 files changed, 0 insertions, 22 deletions
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). |