Skip to content

Commit

Permalink
Merge pull request #462 from GrimoireGL/ci/docs
Browse files Browse the repository at this point in the history
Ci/docs
  • Loading branch information
kyasbal authored Apr 2, 2017
2 parents 62a3313 + 2c58722 commit 4b5239f
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 5,139 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,4 @@ ref
test-es5
src/index.ts
yarn.lock
docs
18 changes: 7 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "grimoirejs",
"version": "0.14.4-beta7",
"version": "0.0.0-development",
"description": "A service-oriented WebGL framework.",
"main": "./ref/index.js",
"typings": "./ref/index.d.ts",
Expand All @@ -15,7 +15,8 @@
"dependencies": {
"@types/node": "^7.0.12",
"events": "^1.1.1",
"grimoirejs-cauldron": "^2.3.3"
"grimoirejs-cauldron": "^2.3.3",
"typedoc": "git://github.com/GrimoireGL/typedoc#includeAll"
},
"devDependencies": {
"ava": "^0.18.2",
Expand All @@ -34,6 +35,8 @@
"sinon": "^2.1.0",
"ts-loader": "^2.0.3",
"tslint": "^5.0.0",
"typedoc": "git+https://github.com/GrimoireGL/typedoc.git",
"typedoc-md-theme": "^1.0.1",
"typescript": "^2.2.2",
"typescript-awaiter": "^1.0.0",
"webpack": "^2.3.2",
Expand All @@ -51,15 +54,8 @@
"build-production": "npm run generate-expose && webpack --progress --env.prod && npm run generate-reference",
"generate-expose": "cauldron generate-exposure --src ./src --dest ./src/index.ts --ts --main ./src/main.ts",
"generate-reference": "cauldron generate-reference --src ./src --dest ./src/index.ts --ts --main ./src/main.ts --dts ./ref",
"semantic-release": "semantic-release pre && npm publish && semantic-release post"
},
"grimoire": {
"doc": {
"src": "./doc",
"header": "./doc/header.md",
"footer": "./doc/footer.md",
"dest": "./lib-md/index.md"
}
"semantic-release": "semantic-release pre && npm publish && semantic-release post",
"doc": "typedoc --out ./docs/ --options typedoc.json ./tsconfig.json"
},
"license": "MIT",
"release": {
Expand Down
4 changes: 4 additions & 0 deletions release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,9 @@ npm run semantic-release
if [ $? = "0" ]; then
echo PRESET_UPDATE
curl "https://preset-updater.herokuapp.com/?repo=preset-basic&repoURL=https://github.com/GrimoireGL/grimoirejs-preset-basic.git&buildNumber=$CIRCLE_BUILD_NUM&currentPkg=grimoirejs"
echo DOCUMENT_GENERATING
npm run doc
echo DOCUMENT_UPLOADING
aws s3 cp ./docs/ s3://circleci-grimoire-e2e/docs/$CIRCLE_PROJECT_REPONAME --recursive
fi
exit 0
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
import __INTERFACE__4 from "./Node/IAttributeDeclaration";
import __INTERFACE__5 from "./Node/ITreeInitializedInfo";

var __VERSION__ = "0.14.4-beta7";
var __VERSION__ = "0.0.0-development";
var __NAME__ = "grimoirejs";

import __MAIN__ from "./main";
Expand Down
10 changes: 10 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"mode": "file",
"moduleResolution": "node",
"tsconfig": "tsconfig.json",
"includeDeclarations": true,
"ignoreCompilerErrors": true,
"excludePrivate": true,
"excludeExternals": true,
"out": "docs/markdown"
}
Loading

0 comments on commit 4b5239f

Please sign in to comment.