Add API doc generation #12
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| #!/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 | ||
| echo "Processing package ${pkg}..." | ||
| 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Post-build cleanup | ||
| if [ -d "_book" ]; then | ||
| echo -e "\033[34mPerforming post-build cleanup...\033[0m" | ||
| cd _book | ||
| rm Gemfile Gemfile.lock Makefile Rakefile make.sh api.sh cleanup.sh | ||
| 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 _interbit apiadoc | ||
| else | ||
| echo -e "\033[1m\033[31m*** Looks like the doc build failed!\033[0m" | ||
| fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "source": { | ||
| "includePattern": ".+\\.js(doc|x)?$", | ||
| "excludePattern": "/(build|dist|tests|node_modules)/" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,32 @@ | ||
| #!/bin/bash | ||
|
|
||
| echo -e "\033[34mBuilding documentation, please wait...\033[0m" | ||
|
|
||
|
|
||
| # Make sure Ruby dependencies 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 -e "\033[34mInstalling GitBook (and other node dependencies)...\033[0m" | ||
| npm i | ||
| fi | ||
|
|
||
| # Install 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 -e "\033[34mBuilding the documentation...\033[0m" | ||
| gitbook build | ||
|
|
||
| # Post-build cleanup | ||
| ./cleanup.sh | ||
|
|
||
| echo -e "\033[1m\033[34mDone!\033[0m" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| = validate | ||
|
|
||
| {% include "/apiadoc/interbit-covenant-tools/validate.adoc" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| = formatDate() | ||
|
|
||
| {% include "/apiadoc/interbit-ui-components/formatDate.adoc" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| = formatDateTime() | ||
|
|
||
| {% include "/apiadoc/interbit-ui-components/formatDateTime.adoc" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| = Interbit | ||
|
|
||
| Interbit offers the same features as the `interbit-cli` but in small | ||
| functions requireable for programmatically managing your chains. | ||
|
|
||
| The `interbit` package contains functions to help you to: | ||
|
|
||
| - gather `interbit-cli` specific command line arguments | ||
| - start Interbit nodes | ||
| - create chains | ||
| - link:configureChains.adoc[configure chains] | ||
| - link:configureJoins.adoc[configure joins] | ||
| - manage covenants | ||
| - connect to peers | ||
| - and so much more! | ||
|
|
||
| Reference: | ||
|
|
||
| - link:/examples/initialize.md[An Example] | ||
| - link:https://github.com/interbit/interbit/blob/master/packages/interbit/src/index.js[The Exports] | ||
| - link:https://www.npmjs.com/package/interbit[The Package] | ||
|
|
||
|
|
||
| == Options | ||
|
|
||
| The main functions available in `interbit` all accept a uniform | ||
| `options` object that correspond to the CLI options used in the | ||
| link:../interbit-cli/README.md[`interbit-cli`] package. | ||
|
|
||
| Some options are not supported in every script and will be ignored. See | ||
| the specific script/cli reference for supported options. | ||
|
|
||
| [horizontal] | ||
| [.api.p]`keyPair` [.api.t]__Object__:: | ||
| A keypair object to boot the hypervisor with. | ||
| + | ||
| -- | ||
| [horizontal] | ||
| [.api.p]`publicKey` [.api.t]__String__:: | ||
| The public key. | ||
|
|
||
| [.api.p]`privateKey` [.api.t]__String__:: | ||
| The private key. | ||
| -- | ||
|
|
||
| [.api.p]`location` [.api.t]__String__:: | ||
| The working directory for this function/script. | ||
|
|
||
| [.api.p]`manifest` [.api.t]__Object__:: | ||
| The contents of the loaded link:../interbit-cli/manifest.adoc[manifest] | ||
| file. | ||
|
|
||
| [.api.p]`config` [.api.t]__Object__:: | ||
| The contents of the loaded link:../interbit-cli/config.adoc[config] | ||
| file. | ||
|
|
||
| [.api.p]`port` [.api.t]__Number__:: | ||
| The port for Interbit to communicate on. | ||
|
|
||
| [.api.p]`dbPath` [.api.t]__String__:: | ||
| The path to the database Interbit is using for this node. | ||
|
|
||
| [.api.p]`connect` [.api.t]__Boolean__:: | ||
| Whether this node is simply connecting to other already running | ||
| instances, or should do the deployment configuration of joins/covenants | ||
| etc. itself. | ||
|
|
||
| [.api.p]`isWatchModeEnabled` [.api.t]__Boolean__ [.api.d]**Default=true**:: | ||
| Whether watch mode is enabled. Defaults to true. | ||
|
|
||
| [.api.p]`isDevModeEnabled` [.api.t]__Boolean__:: | ||
| Whether dev mode is enabled. Defaults to false. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| = Configuration Selectors | ||
|
|
||
| A set of selectors for getting information from a properly formatted | ||
| configuration file. | ||
|
|
||
| == Functions available | ||
|
|
||
| - link:getAdminValidators.adoc[`getAdminValidators`] | ||
| - link:getApps.adoc[`getApps`] | ||
| - link:getChains.adoc[`getChains`] | ||
| - link:getChainByAlias.adoc[`getChainByAlias`] | ||
| - link:getChainCovenant.adoc[`getChainCovenant`] | ||
| - link:getChainJoins.adoc[`getChainJoins`] | ||
| - link:getChainValidators.adoc[`getChainValidators`] | ||
| - link:getJoinTypeForChain.adoc[`getJoinTypeForChain`] | ||
| - link:getCovenants.adoc[`getCovenants`] | ||
| - link:getPeers.adoc[`getPeers`] | ||
|
|
||
| == Objects available | ||
|
|
||
| - link:joinTypes.adoc[`joinTypes`] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| = getAdminValidators() | ||
|
|
||
| == [.signature]__getAdminValidators(config)__ | ||
|
|
||
| == Parameters | ||
|
|
||
| [horizontal] | ||
| [.api.p]`config` [.api.t]__Object__:: | ||
| The configuration to select from. | ||
|
|
||
| == Returns | ||
|
|
||
| [horizontal] | ||
| [.api.t]__Object__:: | ||
| The admin validator public keys. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These function names are not clear when they do not contain the additional scope of the exported object tree. Is there some way we could include the property path from module exports in the documentation for clarity?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I may be reading the source incorrectly, but it looks to me like the top-level exports for
interbit-covenant-toolsincludesvalidate(). So the documentation hierarchy matches exactly. Are you looking for some sort of breadcrumb, so that when you're viewingvalidate()you can see that it's a top-level function?As an aside, the
validate()function's source comments are lacking an@returns, and may need review for accuracy.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are correct, I had thought this was one of
validateManifestorvalidateConfigbut it is not. I forgot that export was ininterbit-covenant-tools. Thanks!