docs: move rendered docs (#1029)

jkowalleck · web-flow · commit b296e45c6882 · 2024-03-17T11:08:09.000+01:00
Signed-off-by: Jan Kowalleck &lt;jan.kowalleck@gmail.com&gt;
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,5 @@
+# rendered api docs
 /api/
+
 /_build/
+/.venv/
diff --git a/docs/api.rst b/docs/api.rst
@@ -4,10 +4,9 @@ API Reference
 For Node
 --------
 
-See the rendered `TypeDoc for Node API <api_node/index.html>`_
+See the `rendered TypeDoc for Node <typedoc/node/index.html>`_
 
 For Web
 -------
 
-See the rendered `TypeDoc for Web API <api_web/index.html>`_
-
+See the `rendered TypeDoc for Web <typedoc/web/index.html>`_
diff --git a/typedoc.node.json b/typedoc.node.json
@@ -3,5 +3,5 @@
   "extends": ["./typedoc.json"],
   "entryPoints": ["src/index.node.ts"],
   "name": "CycloneDX JavaScript Library - Node",
-  "out": "docs/api/api_node/"
+  "out": "docs/api/typedoc/node/"
 }
diff --git a/typedoc.web.json b/typedoc.web.json
@@ -3,5 +3,5 @@
   "extends": ["./typedoc.json"],
   "entryPoints": ["src/index.web.ts"],
   "name": "CycloneDX JavaScript Library - Web",
-  "out": "docs/api/api_web/"
+  "out": "docs/api/typedoc/web/"
 }

-Original file line number
+Diff line change
@@ @@ -1,2 +1,5 @@ @@
 +# rendered api docs
 /api/
++
 /_build/
 +/.venv/
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"extends": ["./typedoc.json"],`
`4`	`4`	`"entryPoints": ["src/index.node.ts"],`
`5`	`5`	`"name": "CycloneDX JavaScript Library - Node",`
`6`		`- "out": "docs/api/api_node/"`
	`6`	`+ "out": "docs/api/typedoc/node/"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@`
`3`	`3`	`"extends": ["./typedoc.json"],`
`4`	`4`	`"entryPoints": ["src/index.web.ts"],`
`5`	`5`	`"name": "CycloneDX JavaScript Library - Web",`
`6`		`- "out": "docs/api/api_web/"`
	`6`	`+ "out": "docs/api/typedoc/web/"`
`7`	`7`	`}`