docs: generating API docs through npm script (ethersphere#85)

* chore: fixed docs creation * ci: check for running the docs * chore: use rimraf instead of rm -rf, simplified typedoc conf * chore: use correct typeRoots
IxaBrjnko · Feb 1, 2021 · 46c4fe8 · 46c4fe8
1 parent 251a650
commit 46c4fe8
Show file tree

Hide file tree

Showing 18 changed files with 1,316 additions and 2,802 deletions.
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -53,3 +53,9 @@ jobs:
       - name: Build browser
         run: npm run compile:browser
 
+      - name: Build typings
+        run: npm run compile:types
+
+      - name: Build docs
+        run: npm run docs
+
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,6 @@ dist
 
 # Dependency directory
 node_modules
+
+# Generated files
+docs
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/classes/_index_.bee.md b/docs/classes/_index_.bee.md
diff --git a/docs/interfaces/_types_.dictionary.md b/docs/interfaces/_types_.dictionary.md
diff --git a/docs/interfaces/_types_.optionsupload.md b/docs/interfaces/_types_.optionsupload.md
diff --git a/docs/interfaces/_types_.tag.md b/docs/interfaces/_types_.tag.md
diff --git a/docs/modules/_index_.md b/docs/modules/_index_.md
diff --git a/docs/modules/_modules_file_.md b/docs/modules/_modules_file_.md