feat(doc-pipeline): add scripts to generate graph api docs (#5678)

* feat: add scripts to generate graph api docs
antvis · Apr 25, 2024 · 1dcbfee · 1dcbfee
1 parent bfbade2
commit 1dcbfee
Show file tree

Hide file tree

Showing 8 changed files with 794 additions and 106 deletions.
diff --git a/packages/g6/src/runtime/graph.ts b/packages/g6/src/runtime/graph.ts
diff --git a/packages/g6/tsdoc.json b/packages/g6/tsdoc.json
@@ -0,0 +1,160 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "noStandardTags": true,
+  "tagDefinitions": [
+    {
+      "tagName": "@alpha",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@beta",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@defaultValue",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@decorator",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@deprecated",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@eventProperty",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@example",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@experimental",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@inheritDoc",
+      "syntaxKind": "inline"
+    },
+    {
+      "tagName": "@internal",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@label",
+      "syntaxKind": "inline"
+    },
+    {
+      "tagName": "@link",
+      "syntaxKind": "inline",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@override",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@packageDocumentation",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@param",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@privateRemarks",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@public",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@readonly",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@remarks",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@returns",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@sealed",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@see",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@throws",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@typeParam",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@virtual",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@betaDocumentation",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@internalRemarks",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@preapproved",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@apiCategory",
+      "syntaxKind": "block"
+    }
+  ],
+  "supportForTags": {
+    "@alpha": true,
+    "@beta": true,
+    "@defaultValue": true,
+    "@decorator": true,
+    "@deprecated": true,
+    "@eventProperty": true,
+    "@example": true,
+    "@experimental": true,
+    "@inheritDoc": true,
+    "@internal": true,
+    "@label": true,
+    "@link": true,
+    "@override": true,
+    "@packageDocumentation": true,
+    "@param": true,
+    "@privateRemarks": true,
+    "@public": true,
+    "@readonly": true,
+    "@remarks": true,
+    "@returns": true,
+    "@sealed": true,
+    "@see": true,
+    "@throws": true,
+    "@typeParam": true,
+    "@virtual": true,
+    "@betaDocumentation": true,
+    "@internalRemarks": true,
+    "@preapproved": true,
+    "@apiCategory": true
+  },
+  "reportUnsupportedHtmlElements": false
+}