cargdev/angular
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

build(aio): move doc-gen stuff from angular.io (#14097)

Browse Source
This commit is contained in:
Peter Bacon Darwin
2017-01-26 14:03:53 +00:00
committed by Igor Minar
parent d1d0ce7613
commit b7763559cd
135 changed files with 5031 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
tools/docs/README.md Normal file
View File

@ -0,0 +1,27 @@
# Documentation Generation
The dgeni tool is used to generate the documentation from the source files held in this repository.
The documentation generation is configured by a dgeni package defined in `docs/angular.io-package/index.js`.
This package, in turn requires a number of other packages, some are defined locally in the `docs` folder,
such as `docs/cheatsheet-package` and `docs/content-package`, etc. And some are brought in from the
`dgeni-packages` node modules, such as `jsdoc` and `nunjucks`.
## Generating the docs
To generate the documentation simply run `gulp docs` from the command line.
## Testing the dgeni packages
The local packages have unit tests that you can execute by running `gulp docs-test` from the command line.
## What does it generate?
The output from dgeni is written to files in the `dist/docs` folder.
Notably this includes a partial HTML file for each "page" of the documentation, such as API pages and guides.
It also includes JavaScript files that contain metadata about the documentation such as navigation data and
keywords for building a search index.
## Viewing the docs
You can view the dummy demo app using a simple HTTP server hosting `dist/docs/index.html`