From 5e013c4aef4e7afe0a38cda28e6ebcf8ff7014ee Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Wed, 2 Sep 2015 17:08:16 -0700 Subject: [PATCH] doc(DEVELOPER): describe how to generate & serve API docs Closes #3968 --- DEVELOPER.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/DEVELOPER.md b/DEVELOPER.md index 95ef5e4ec8..99f3955669 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -255,7 +255,22 @@ to some whitespace difference. - Working directory: `$ProjectFileDir$` * `clang-format` integrations are also available for many popular editors (`vim`, `emacs`, `Sublime Text`, etc.). + +## Generating the API documentation +The following gulp task will generate the API docs in the `dist/angular.io/partials/api/angular2`: + +```shell +$(npm bin)/gulp docs/angular.io +``` + +You can serve the generated documentation to check how it would render on [angular.io](https://angular.io/): +- check out the [angular.io repo](https://github.com/angular/angular.io) locally, +- install dependencies as described in the [angular.io README](https://github.com/angular/angular.io/blob/master/README.md), +- copy the generated documentation from your local angular repo at `angular/dist/angular.io/partials/api/angular2` to your local angular.io repo at `angular.io/public/docs/js/latest/api`, +- run `harp compile` at the root of the angular.io repo to check the generated documentation for errors, +- run `harp server` and open a browser at `http://localhost:9000/docs/js/latest/api/` to check the rendered documentation. + ## Project Information ### Folder structure