Add documentation site commands to Gulp config

This commit is contained in:
Christopher C. Wells 2021-12-22 11:32:53 -05:00
parent c01dbee4c7
commit c8ed066806
2 changed files with 49 additions and 0 deletions

View File

@ -155,6 +155,9 @@ management commands.
- [`gulp compilemessages`](#compilemessages) - [`gulp compilemessages`](#compilemessages)
- [`gulp coverage`](#coverage) - [`gulp coverage`](#coverage)
- [`gulp createcachetable`](#createcachetable) - [`gulp createcachetable`](#createcachetable)
- [`gulp docs:build`](#docsbuild)
- [`gulp docs:deploy`](#docsdeploy)
- [`gulp docs:watch`](#docswatch)
- [`gulp extras`](#extras) - [`gulp extras`](#extras)
- [`gulp fake`](#fake) - [`gulp fake`](#fake)
- [`gulp lint`](#lint) - [`gulp lint`](#lint)
@ -179,6 +182,19 @@ server IP address. See [`gulp runserver`](#runserver) for details.
Creates all script, style and "extra" assets and places them in the Creates all script, style and "extra" assets and places them in the
`babybuddy/static` folder. `babybuddy/static` folder.
#### `docs:build`
Builds the documentation site in a local directory (`site` by default).
#### `docs:deploy`
Deploys the documentation site to GitHub Pages.
#### `docs:watch`
Runs a local server for the documentation site reloading whenever documentation
sites files (in the `docs` directory) as modified.
#### `clean` #### `clean`
Deletes all build folders and the root `static` folder. Generally this should Deletes all build folders and the root `static` folder. Generally this should

View File

@ -89,6 +89,33 @@ function coverage(cb) {
}); });
} }
/**
* Builds the documentation site locally.
*
* @param cb
*/
function docsBuild(cb) {
_runInPipenv(['mkdocs', 'build'], cb);
}
/**
* Deploys the documentation site to GitHub Pages.
*
* @param cb
*/
function docsDeploy(cb) {
_runInPipenv(['mkdocs', 'gh-deploy'], cb);
}
/**
* Serves the documentation site, watching for changes.
*
* @param cb
*/
function docsWatch(cb) {
_runInPipenv(['mkdocs', 'serve'], cb);
}
/** /**
* Builds and copies "extra" static files to configured paths. * Builds and copies "extra" static files to configured paths.
* *
@ -322,6 +349,12 @@ gulp.task('clean', clean);
gulp.task('coverage', coverage); gulp.task('coverage', coverage);
gulp.task('docs:build', docsBuild);
gulp.task('docs:deploy', docsDeploy);
gulp.task('docs:watch', docsWatch);
gulp.task('extras', extras); gulp.task('extras', extras);
gulp.task('lint', lint); gulp.task('lint', lint);