[incubator-annotator] 02/02: Tweak typedoc config

[ge...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gerben pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git

commit 846870adf4c1b344b4da66548b57ee57f5d3b51a
Author: Gerben <ge...@treora.com>
AuthorDate: Sat May 8 22:41:01 2021 +0200

    Tweak typedoc config
    
    Setting "disableSources" because the generated links incorrectly point
    to generated files (lib/….d.ts) rather than their source files.
    (why does it not use the declaration map to find the correct file&line?)
    
    If we do get it to work, we could use typedoc-plugin-sourcefile-url to
    point to the apache repo by adding:
      "sourcefile-url-prefix": "https://gitbox.apache.org/repos/asf?p=incubator-annotator.git;a=blob;hb=refs/heads/master;f=packages/"
---
 typedoc.json | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/typedoc.json b/typedoc.json
index bd8a5e1..76bc567 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -1,3 +1,5 @@
 {
-  "entryPoints": ["packages/apache-annotator/src/"]
+  "disableSources": true,
+  "entryPoints": ["packages/apache-annotator/src/"],
+  "readme": "none"
 }