Add API doc generation

.gitignore

@@ -1,13 +1,13 @@
 node_modules
-lerna-debug.log
 npm-debug.log
-packages/*/node_modules
-packages/*/npm-debug.log
+_interbit
+apiadoc
 **/db-*
 **/_book
 **/build
 **/.lock
 **/dist
+**/.DS_Store
 
 # Vim ignores
 [._]*.s[a-v][a-z]

SUMMARY.md

@@ -44,6 +44,7 @@
     * [Constants](reference/interbit/constants.md)
     * [configSelectors](reference/interbit/configSelectors.md)
     * [createChains()](reference/interbit/createChains.md)
+    * [createChainsFromManifest()](reference/interbit/createChainsFromManifest.adoc)
     * [deploy()](reference/interbit/deploy.md)
     * [manifestSelectors](reference/interbit/manifestSelectors.md)
     * [startInterbit()](reference/interbit/startInterbit.md)
@@ -57,7 +58,10 @@
     * [manifest file](reference/interbit-cli/manifest.adoc)
     * [start](reference/interbit-cli/start.md)
   * [interbit-covenant-tools](reference/interbit-covenant-tools/README.md)
+    * [validate()](reference/interbit-covenant-tools/validate.adoc)
   * [interbit-ui-components](reference/interbit-ui-components/README.md)
+    * [formatDate()](reference/interbit-ui-components/formatDate.adoc)
+    * [formatDateTime()](reference/interbit-ui-components/formatDateTime.adoc)
   * [interbit-ui-tools](reference/interbit-ui-tools/README.adoc)
     * [actionCreators](reference/interbit-ui-tools/actionCreators.md)
     * [actionTypes](reference/interbit-ui-tools/actionTypes.md)

api.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Capture source comments for select packages
+APIDIR=_interbit/_API
+rm -rf ${APIDIR}
+
+PKGDIR=_interbit/packages
+JSONDIR=${APIDIR}/json
+ADOCDIR=apiadoc
+rm -rf ${ADOCDIR}
+mkdir -p ${JSONDIR}
+mkdir ${ADOCDIR}
+
+packages=(
+  'interbit'
+  'interbit-covenant-tools'
+  'interbit-platform-tools'
+  'interbit-ui-components'
+  'interbit-ui-tools'
+)
+for pkg in ${packages[@]}; do
+  jsdoc -r -X -c conf.jsdoc ${PKGDIR}/${pkg} > ${JSONDIR}/${pkg}.json
+  node_modules/gitbook-plugin-interbit/scripts/apijson2adoc.js -j ${JSONDIR}/${pkg}.json -d ${ADOCDIR} -p ${pkg}
+done

conf.jsdoc

@@ -0,0 +1,6 @@
+{
+  "source": {
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "/(build|dist|tests|node_modules)/"
+  }
+}

make.sh

@@ -1,34 +1,41 @@
 #!/bin/bash
 
-echo 'Building documentation, please wait... '
+echo -e "\033[34mBuilding documentation, please wait...\033[0m"
 
 # Make sure Ruby dependencies installed
-bundle install || echo "Ruby dependencies failed to install; make sure Bundler is installed!"
+bundle install || echo -e "\033[31mRuby dependencies failed to install; make sure Bundler is installed!\033[0m"
 
 # Make sure that `gitbook` command is installed
 if ! [ -x "$(command -v gitbook)" ]; then
-  echo "Installing GitBook (and other node dependencies)..."
+  echo -e "\033[34mInstalling GitBook (and other node dependencies)...\033[0m"
   npm i
 fi
 
 # Install GitBook plugins, themes, etc.
-echo "Installing GitBook plugins, themes, etc..."
+echo -e "\033[34mInstalling GitBook plugins, themes, etc...\033[0m"
 gitbook install
 
+# Capture source comments for select packages
+echo -e "\033[34mCollecting API details...\033[0m"
+
+rm -rf _interbit
+git clone https://github.com/interbit/interbit.git _interbit
+./api.sh
+
 # Build the book's HTML
-echo "Building the documentation..."
+echo -e "\033[34mBuilding the documentation...\033[0m"
 gitbook build
 
 # Post-build cleanup
 if [ -d "_book" ]; then
-  echo "Performing post-build cleanup..."
+  echo -e "\033[34mPerforming post-build cleanup...\033[0m"
   cd _book
   rm Gemfile Gemfile.lock Makefile make.sh Rakefile
-  rm -f npm-debug.log package.json package-lock.json
+  rm -f npm-debug.log package.json package-lock.json conf.jsdoc
   rm index.js local.js app.json README.md .gitignore
-  rm -rf vendor
+  rm -rf vendor _interbit apiadoc
 else
-  echo "*** Looks like the doc build failed!"
+  echo -e "\033[1m\033[31m*** Looks like the doc build failed!\033[0m"
 fi
 
-echo "Done!"
+echo -e "\033[1m\033[34mDone!\033[0m"

package.json

@@ -7,6 +7,7 @@
   "dependencies": {
     "gitbook-cli": "^2.3.2",
     "express": "^4.16.3",
+    "jsdoc": "^3.5.5",
     "heroku-ssl-redirect": "^0.0.4"
   },
   "repository": {
@@ -23,6 +24,8 @@
     "start": "node index.js",
     "build": "bash make.sh",
     "test": "node node_modules/gitbook-plugin-interbit/scripts/doc_checks.js",
+    "spell": "node node_modules/gitbook-plugin-interbit/scripts/doc_checks.js -c spelling",
+    "includes": "node node_modules/gitbook-plugin-interbit/scripts/doc_checks.js -c includes",
     "heroku-postbuild": "npm run build"
   },
   "engines": {

reference/interbit-covenant-tools/validate.adoc

@@ -0,0 +1,3 @@
+= validate
+
+{% include "/apiadoc/interbit-covenant-tools/validate.adoc" %}

reference/interbit-ui-components/formatDate.adoc

@@ -0,0 +1,3 @@
+= formatDate()
+
+{% include "/apiadoc/interbit-ui-components/formatDate.adoc" %}

reference/interbit-ui-components/formatDateTime.adoc

@@ -0,0 +1,3 @@
+= formatDateTime()
+
+{% include "/apiadoc/interbit-ui-components/formatDateTime.adoc" %}

reference/interbit/createChainsFromManifest.adoc

@@ -0,0 +1,3 @@
+= createChainsFromManifest()
+
+{% include "/apiadoc/interbit/createChainsFromManifest.adoc" %}