2
1
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2023-12-13 21:00:40 +01:00

Docs: switch to docker & finalise config

- We no longer need grunt-groc as we are going to use docker instead
 - Compile docker to 'docs'
 - Docker has a nice option for only building updated files
 - Added a few files we didn't need dockering to exclude list
This commit is contained in:
Hannah Wolfe 2014-05-05 16:26:19 +01:00
parent d4b1693a2c
commit 046993add0
2 changed files with 6 additions and 32 deletions

View file

@ -311,43 +311,18 @@ var path = require('path'),
}
},
// ### grunt-groc
// Generate documentation from code
groc: {
docs: {
options: {
out: './docs/',
glob: [
'README.md',
'CONTRIBUTING.md',
'SECURITY.md',
'Gruntfile.js',
'config.example.js',
'index.js',
'core/*.js',
'core/server/**/*.js',
'core/shared/**/*.js',
'core/client/**/*.js'
],
except: [
'!core/**/vendor/**/*.js',
'!core/client/tpl/**/*.js'
]
}
}
},
// ### grunt-docker
// Generate documentation from code
docker: {
docs: {
dest: 'docks',
dest: 'docs',
src: ['.'],
options: {
exclude: 'node_modules,.git,.tmp,bower_components,content,*built,*test,*doc*,*vendor,config.js,coverage.html,.travis.yml',
onlyUpdated: true,
exclude: 'node_modules,.git,.tmp,bower_components,content,*built,*test,*doc*,*vendor,' +
'config.js,coverage.html,.travis.yml,*.min.css,screen.css',
extras: ['fileSearch']
}
}
},
@ -621,7 +596,7 @@ var path = require('path'),
// ### Documentation
// Run `grunt docs` to generate annotated source code using the documentation described in the code comments.
grunt.registerTask('docs', 'Generate Docs', ['docker', 'groc']);
grunt.registerTask('docs', 'Generate Docs', ['docker']);
// ## Testing
@ -850,7 +825,7 @@ var path = require('path'),
'Release task - creates a final built zip\n' +
' - Do our standard build steps (handlebars, etc)\n' +
' - Copy files to release-folder/#/#{version} directory\n' +
' - Clean out unnecessary files (travis, .git*, .af*, .groc*)\n' +
' - Clean out unnecessary files (travis, .git*, etc)\n' +
' - Zip files in release-folder to dist-folder/#{version} directory',
['shell:bower', 'handlebars', 'concat', 'uglify', 'clean:release', 'copy:release', 'compress:release']);
};

View file

@ -73,7 +73,6 @@
"grunt-contrib-watch": "~0.5.3",
"grunt-docker": "~0.0.8",
"grunt-express-server": "~0.4.11",
"grunt-groc": "~0.4.5",
"grunt-mocha-cli": "~1.4.0",
"grunt-shell": "~0.6.1",
"grunt-update-submodules": "~0.2.1",