scripts for generating docs

justadudewhohacks · justadudewhohacks · commit df59d2fea63a · 2018-10-23T21:02:20.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ node_modules
 tmp
 proto
 weights_uncompressed
-weights_unused
+weights_unused
+docs
diff --git a/.npmignore b/.npmignore
@@ -7,4 +7,5 @@ weights
 weights_uncompressed
 weights_unused
 test
-tools
+tools
+docs
diff --git a/typedoc.config.js b/typedoc.config.js
@@ -0,0 +1,33 @@
+const path = require('path')
+const fs = require('fs')
+
+const excludes = [
+  { dir: 'faceLandmarkNet', exceptions: ['index.ts', 'FaceLandmark68Net.ts', 'FaceLandmark68TinyNet.ts'] },
+  { dir: 'faceRecognitionNet', exceptions: ['index.ts', 'FaceRecognitionNet.ts'] },
+  { dir: 'mtcnn', exceptions: ['index.ts', 'Mtcnn.ts', 'MtcnnOptions.ts'] },
+  { dir: 'ssdMobilenetv1', exceptions: ['index.ts', 'SsdMobilenetv1.ts', 'SsdMobilenetv1Options.ts'] },
+  { dir: 'tinyFaceDetector', exceptions: ['index.ts', 'TinyFaceDetector.ts', 'TinyFaceDetectorOptions.ts'] },
+  { dir: 'tinyYolov2', exceptions: ['index.ts', 'TinyYolov2.ts'] }
+]
+
+const exclude = excludes.map(({ dir, exceptions }) => {
+  const files = fs.readdirSync(path.resolve('src', dir))
+    .filter(file => !exceptions.some(ex => ex === file))
+
+  return files.map(file => `**/${dir}/${file}`)
+}).reduce((flat, arr) => flat.concat(arr), [])
+
+module.exports = {
+  mode: 'file',
+  out: 'docs',
+  module: 'commonjs',
+  target: 'es5',
+  theme: 'default',
+  excludeExternals: true,
+  includeDeclarations: true,
+  excludePrivate: true,
+  excludeNotExported: true,
+  stripInternal: true,
+  externalPattern: 'node_modules/@tensorflow',
+  exclude
+}
