From f77b1cd62c97033ef77dd12b5d5f8754faca4a58 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Thu, 18 Dec 2014 17:02:52 -0500 Subject: [PATCH] Moved docs to match organization and naming of `lib` (mostly) --- docs/{helpers => }/Networks.md | 0 docs/{helpers => }/PaymentProtocol.md | 0 docs/{models/Address.md => address.md} | 0 docs/{models/Block.md => block.md} | 0 docs/config.json | 6 ------ docs/{helpers/Crypto.md => crypto.md} | 0 docs/{helpers/ECIES.md => ecies.md} | 0 docs/{helpers/Encoding.md => encoding.md} | 0 docs/{models/Hierarchical.md => hierarchical.md} | 0 docs/{networking/JSONRPC.md => jsonrpc.md} | 0 docs/{networking/Peer.md => peer.md} | 0 docs/{networking/Pool.md => pool.md} | 0 docs/{models/PrivateKey.md => privatekey.md} | 0 docs/{models/PublicKey.md => publickey.md} | 0 docs/{models/Script.md => script.md} | 0 docs/{models/Transaction.md => transaction.md} | 0 docs/{helpers/Unit.md => unit.md} | 0 docs/{helpers/URI.md => uri.md} | 0 gulpfile.js | 2 +- package.json | 2 +- 20 files changed, 2 insertions(+), 8 deletions(-) rename docs/{helpers => }/Networks.md (100%) rename docs/{helpers => }/PaymentProtocol.md (100%) rename docs/{models/Address.md => address.md} (100%) rename docs/{models/Block.md => block.md} (100%) delete mode 100644 docs/config.json rename docs/{helpers/Crypto.md => crypto.md} (100%) rename docs/{helpers/ECIES.md => ecies.md} (100%) rename docs/{helpers/Encoding.md => encoding.md} (100%) rename docs/{models/Hierarchical.md => hierarchical.md} (100%) rename docs/{networking/JSONRPC.md => jsonrpc.md} (100%) rename docs/{networking/Peer.md => peer.md} (100%) rename docs/{networking/Pool.md => pool.md} (100%) rename docs/{models/PrivateKey.md => privatekey.md} (100%) rename docs/{models/PublicKey.md => publickey.md} (100%) rename docs/{models/Script.md => script.md} (100%) rename docs/{models/Transaction.md => transaction.md} (100%) rename docs/{helpers/Unit.md => unit.md} (100%) rename docs/{helpers/URI.md => uri.md} (100%) diff --git a/docs/helpers/Networks.md b/docs/Networks.md similarity index 100% rename from docs/helpers/Networks.md rename to docs/Networks.md diff --git a/docs/helpers/PaymentProtocol.md b/docs/PaymentProtocol.md similarity index 100% rename from docs/helpers/PaymentProtocol.md rename to docs/PaymentProtocol.md diff --git a/docs/models/Address.md b/docs/address.md similarity index 100% rename from docs/models/Address.md rename to docs/address.md diff --git a/docs/models/Block.md b/docs/block.md similarity index 100% rename from docs/models/Block.md rename to docs/block.md diff --git a/docs/config.json b/docs/config.json deleted file mode 100644 index 76f478a..0000000 --- a/docs/config.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "useSideMenu": true, - "lineBreaks": "gfm", - "additionalFooterText": "Bitcore™ © 2013-2014 BitPay, Inc. Bitcore is released under the MIT license. ", - "anchorCharacter": "#" -} \ No newline at end of file diff --git a/docs/helpers/Crypto.md b/docs/crypto.md similarity index 100% rename from docs/helpers/Crypto.md rename to docs/crypto.md diff --git a/docs/helpers/ECIES.md b/docs/ecies.md similarity index 100% rename from docs/helpers/ECIES.md rename to docs/ecies.md diff --git a/docs/helpers/Encoding.md b/docs/encoding.md similarity index 100% rename from docs/helpers/Encoding.md rename to docs/encoding.md diff --git a/docs/models/Hierarchical.md b/docs/hierarchical.md similarity index 100% rename from docs/models/Hierarchical.md rename to docs/hierarchical.md diff --git a/docs/networking/JSONRPC.md b/docs/jsonrpc.md similarity index 100% rename from docs/networking/JSONRPC.md rename to docs/jsonrpc.md diff --git a/docs/networking/Peer.md b/docs/peer.md similarity index 100% rename from docs/networking/Peer.md rename to docs/peer.md diff --git a/docs/networking/Pool.md b/docs/pool.md similarity index 100% rename from docs/networking/Pool.md rename to docs/pool.md diff --git a/docs/models/PrivateKey.md b/docs/privatekey.md similarity index 100% rename from docs/models/PrivateKey.md rename to docs/privatekey.md diff --git a/docs/models/PublicKey.md b/docs/publickey.md similarity index 100% rename from docs/models/PublicKey.md rename to docs/publickey.md diff --git a/docs/models/Script.md b/docs/script.md similarity index 100% rename from docs/models/Script.md rename to docs/script.md diff --git a/docs/models/Transaction.md b/docs/transaction.md similarity index 100% rename from docs/models/Transaction.md rename to docs/transaction.md diff --git a/docs/helpers/Unit.md b/docs/unit.md similarity index 100% rename from docs/helpers/Unit.md rename to docs/unit.md diff --git a/docs/helpers/URI.md b/docs/uri.md similarity index 100% rename from docs/helpers/URI.md rename to docs/uri.md diff --git a/gulpfile.js b/gulpfile.js index aa12152..adcbf43 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -126,7 +126,7 @@ gulp.task('lint', function() { gulp.task('plato', shell.task(['plato -d report -r -l .jshintrc -t bitcore lib'])); -gulp.task('jsdoc', shell.task(['jsdoc -c .jsdoc.conf lib'])); +gulp.task('jsdoc', shell.task(['node_modules/.bin/jsdoc2md lib/address.js > docs/api/address.md'])); gulp.task('coverage', shell.task(['node_modules/.bin/./istanbul cover node_modules/.bin/_mocha -- --recursive'])); diff --git a/package.json b/package.json index f49dd53..b2a8e99 100644 --- a/package.json +++ b/package.json @@ -95,12 +95,12 @@ "gulp": "^3.8.10", "gulp-closure-compiler": "^0.2.9", "gulp-coveralls": "^0.1.3", - "gulp-jsdoc": "^0.1.4", "gulp-jshint": "^1.9.0", "gulp-mocha": "^2.0.0", "gulp-shell": "^0.2.10", "ink-docstrap": "git://github.com/bitpay/bitcore-jsdoctemplates.git", "istanbul": "^0.3.5", + "jsdoc-to-markdown": "=0.5.9", "karma": "^0.12.28", "karma-firefox-launcher": "^0.1.3", "karma-mocha": "^0.1.9",