Commit Graph

198 Commits

Author SHA1 Message Date
Patrice Chalin aa439d28c5 chore(travis): report bad code excerpts (BAD FILENAME) in docs (#2154)
* chore(travis): report bad code excerpts (BAD FILENAME)

* Only ignore build dir under dart dir

Have the shredder ignore `**/dart/build/**`.
2016-08-23 10:16:47 -07:00
Patrice Chalin 5d1da1e047 chore(dart/cheatsheet): adjust path to sources (#2149) 2016-08-19 14:58:31 -07:00
Patrice Chalin 2fd162425d chore(dart): api doc builder enhancements (#2050)
- #2049, support ng.io doc relative links and code-regions
- Change dartdoc output folder to `docs/api` (from `doc/api`).
2016-08-10 10:36:23 -07:00
Peter Bacon Darwin d79adb2422 docs(rc5): update docs and plunkers for rc5 2016-08-09 11:48:07 -07:00
Peter Bacon Darwin 2fb503dabf doc-gen: fix filterable API list
Closes #2054
2016-08-09 10:51:16 -07:00
AlmeroSteyn 177161a708 docs-styles(build): new a11y-compliant styles for doc sample
closes #1897
Generates a2docs.css from a11y-compliant less file
See PR #1897 for more info and next steps.
2016-08-06 11:43:00 -07:00
Peter Bacon Darwin 63e0e6eaf6 doc-gen: ignore new private module 2016-08-06 07:18:23 +01:00
Jesús Rodríguez 818c82c2a2 chore: add README.md to each plunker
closes #1974
2016-08-01 12:48:04 -07:00
Eric Jimenez cece720f47 output an audit file to keep track of documentation progress on API 2016-07-28 13:44:07 -07:00
Eric Jimenez ca0acb6107 hide notes if none are found 2016-07-27 12:50:23 -04:00
Jesús Rodríguez 20350f4b40 chore: remove global variable at plunker-builder
closes #1946
2016-07-25 10:03:51 -07:00
Patrice Chalin 753452650c docs(cheatsheet/dart): generate from dart sources (#1912)
* docs(cheatsheet/dart): generate from dart sources

Fixes #1906.
2016-07-19 12:35:39 -07:00
Patrice Chalin 1bef20abc4 docs(api/dart): add support for generation and display (#1888)
Fixes #1880.
Supersedes #1593.
2016-07-15 14:10:12 -07:00
Patrice Chalin cc689ce980 chore(api doc gen): log 'no api docs' as info not warning
closes #1860
There are too many undocumented interfaces to consider lack of API docs
in a source file to be worth a warning. The original author even
questions whether there should be such a warning. It is now logged at
the `info` level.
2016-07-14 14:36:50 -07:00
Peter Bacon Darwin 285ecf495f chore(api-builder): add configurable link disambuators & put to work
closes #1852
Add configurable link disambuators
Add a service to disambiguate docs by module
Add a service to disambiguate docs that are deprecated
2016-07-14 14:33:55 -07:00
Patrice Chalin 4da23bfe57 chore(api-builder): linkDevGuide -> linkDocs;linkDocs can default the lang
closes #1849

1) Rename linkDevGuide to linkDocs

Rename the specialized API docs `@linkDevGuide` tag to `@linkDocs`
since it is meant to be used to refer to all angular.io docs, not just
the developer guide.

2) let linkDocs links resolve to proper language

The old linkDevGuide required URIs to be given in the form
'ts/latest/guide/architecture' which forced all language versions of
the API pages to refer to the ts versions of the doc pages they linked
to.

This PR fixes that problem. URIs are now given in the form
'guide/architecture' and then rendered properly for each language. Of
course, when needed, it is still possible to give a language specific
URI.

chore(api-builder): minor code cleanup
2016-07-14 14:30:26 -07:00
Jesús Rodríguez 4ff714c99f refactor: some changes to plunkerBuilder
closes #1885
2016-07-14 14:18:20 -07:00
Patrice Chalin 86f82124d4 chore: dgeni tag defintions for ts2dart tags
closes #1833
New `dgeni` tag definitions for `ts2dart` tags which are currently
causing spurious warnings when generating API docs.
2016-07-11 20:14:21 -07:00
Patrice Chalin fb9edf972e chore: fix "Invalid example" warnings from shred map builder
closes #1832
The shred map (xref) builder was issuing warnings. This fix includes
- Adjustments to the shredder map builder itself so that it
understands, e.g., app-project relative example paths.
- `**/guide/glossary.jade` now (Jade) `includes` the shared parent
`glossary.jade` rather than (Harp) importing (via `partial`). This
fixes `makeExample` path issues in the glossary.
- Adjusted some `makeExample` paths that were ok for site build, but
confused the xref tool.
2016-07-11 20:10:56 -07:00
Foxandxss 8b05dd2726 chore: show new forms library via the api-builder
closes #1829
2016-07-05 23:35:12 -07:00
Patrice Chalin 67ee007fb0 chore(docs build): add flag to control log output level
closes #1823

Gulp targets like `check-deploy` and `serve-and-sync-devguide` are
quite verbose. This PR allows the `dgeni` logging level to be
controlled using the `--dgeni-log` flag. E.g., use `--dgen-log="error"`
to see only errors.

Also sets log level to "error" when gulp is silent
and log level for createShredMapPackage
2016-07-05 23:14:43 -07:00
Foxandxss d1e6a24987 chore: add support for multiline annotations in the API 2016-07-04 17:03:20 +02:00
Naomi Black 2480a91570 chore(api): remove internal compiler API from docgen
closes #1771
2016-06-28 11:37:53 -07:00
Filipe Silva 3db8642113 fix(quickstart): add styles.css to js quickstart
Fix #1684

While looking at this, I saw that plunkers were getting some unintended unit testing files and added them to the default plunker builder ignore.
2016-06-19 22:52:59 -07:00
Peter Bacon Darwin 7ee6e63a6f api-builder: ignore additional platform browser private exports
These exports should not be part of the docs and
cause the doc-gen to fail.

Closes #1667
2016-06-15 08:31:30 +01:00
Peter Bacon Darwin c4e87d9b83 api-builder: fix jade formatting of indented constructor code
Closes #1662
2016-06-13 22:42:56 -07:00
Filipe Silva 49a7bc3860 chore: Partition example shredder to do one directory at a time
also exclude /dist/ folder and exclude _examples from jade shredder
closes #1661
2016-06-13 22:20:45 -07:00
Foxandxss 21d74d531a chore: update all packages to latest versions
closes #1607
2016-06-06 12:24:25 -07:00
Eric Jimenez 1324085c0c feat(api docs): use partials for api docs. Implement deprecated and security notes section 2016-06-02 18:44:32 -07:00
Vikash 8569479423 docs: fix numerous typos in many doc files.
closes #1509
2016-06-01 01:08:56 -07:00
Ward Bell 3423ad8491 chore: more conversion of es6-shim to core-js 2016-05-19 23:18:18 -07:00
Foxandxss 3a6d223efb chore: translate inline system config for plunker
closes #1439
2016-05-19 19:19:08 -07:00
Peter Bacon Darwin 16dccb6a6b api-builder: consolidate readTypescriptProcessor configuration
closes #1440
2016-05-19 19:16:49 -07:00
Peter Bacon Darwin 0cb0bd7949 api-builder: fix class github link formatting 2016-05-19 19:16:24 -07:00
Peter Bacon Darwin a42f3bf085 api-builder: fix githublinks
Closes #1435
Closes #1433
2016-05-19 19:16:24 -07:00
Ward Bell ba02c40b56 docs: switch from es6-shim to core-js shim 2016-05-19 16:37:54 -07:00
Ward Bell e9dd6334e4 docs(plunker): use the FrankWallis TS plugin (thx Filipe!) 2016-05-15 14:49:09 -07:00
Eric Jimenez 621bc31c61 feat(no index): remove index from api list, it is unnecessary additional information from dgeni 2016-05-12 17:49:16 -07:00
Eric Jimenez b5d2973163 feat(security badge): add a security badge to api docs. Only appears if @security is present in angular2 2016-05-12 17:48:54 -07:00
Peter Bacon Darwin 92ca0f3a9f api-builder: add project specific typescript configuration 2016-05-12 03:40:57 -07:00
Peter Bacon Darwin ac583748d1 api-builder: update to dgeni-packages 0.12.0 - factoring out the typescript package 2016-05-12 03:40:57 -07:00
Eric Jimenez d26461024c feat(dgeni audit): add more keys to the api-list, this makes it easier to see changes across the api 2016-05-11 19:46:23 -07:00
Ward Bell 19b50c82f6 docs(plunker): revise systemjs.config for plunker to load fewer files 2016-05-11 18:42:13 -07:00
Naomi Black 8a29e502d3 chore(api): hide another private function 2016-05-03 18:48:09 -07:00
Ward Bell b4f567458e docs(ts/js): update to rc1 2016-05-03 17:29:00 -06:00
Ward Bell 3d5302adce chore: update to rc.0 2016-05-02 19:57:28 -07:00
Naomi Black d442b30a68 chore(dgeni): update dgeni to serve old and new router 2016-05-02 17:42:05 -07:00
Naomi Black acc5233671 chore(dgeni): update dgeni to handle repackaging changes 2016-05-02 13:00:06 -07:00
Naomi Black b89647add4 chore(dgeni): fix missing apis in the master list 2016-04-29 17:20:59 -07:00
Naomi Black e91b4254de docs(dgeni): fix Location-class missing from API list 2016-04-28 19:21:26 -07:00
Filipe Silva 216120daba chore: update to beta.17
closes #1213, 1205
2016-04-28 18:31:00 -07:00
Eric Jimenez 1ac2a42308 chore(not yet documented): remove placeholder to reduce noise 2016-04-27 12:55:27 -04:00
Filipe Silva 0a606a1b41 chore(ts): updating to beta.16 2016-04-26 00:22:25 -07:00
Eric Jimenez 59c76790af docs(class, decorator, directive, function, var) improve doc styling 2016-04-25 16:58:03 -07:00
Eric Jimenez 8f158f2241 docs(sidenav reorg): remove glossary and cheatsheet from REFERENCE. Move glossary to BASICS. Rename REFERENCE to API REFERENCE 2016-04-25 14:10:57 -07:00
Eric Jimenez 9787a9ffb8 docs(static methods): fix style of static methods in api doc. anchoring works now 2016-04-22 17:13:05 -04:00
Eric Jimenez baf84a48e8 docs(static methods): fix style of static methods in api doc. anchoring works now 2016-04-22 17:03:34 -04:00
Eric Jimenez c932eec801 docs(code color fix): restored old color for code in parts that are not the api doc, use the same styling for all links in entire site 2016-04-21 12:03:12 -04:00
Eric Jimenez 3dd114d0df docs(class overview): list instance and static members with in-page hyperlinks. Also link constructor when present. Focus member on click. Badges look better in viewports of 600px or less 2016-04-20 13:14:18 -07:00
Eric Jimenez c934fb704f docs(badges): add badges in hero to identify doc type to viewer, and stability. Stylize var.template for new api style docs. Add stable, experimental, docsNotRequired tagdef in dgeni 2016-04-19 20:49:48 -07:00
Eric Jimenez 5ea7738ad3 change class and directive template. 2016-04-16 03:17:47 -07:00
Ward Bell f2f5d9f9ae docs(ts): update to beta.15
also restore accidentally deleted router sample files
2016-04-13 19:26:48 -07:00
Filipe Silva 0ef63166f8 chore: update to beta.14 2016-04-07 21:31:40 +01:00
Ward Bell 7fdb40caa3 chore: replace VSCode-specific settings.json with broadly recommended .editorconfig
closes #1022
2016-04-05 10:15:27 -07:00
Peter Bacon Darwin d6d46076b7 fix(api-builder): add missing git package dependency
This was causing the api-builder tests to fail
2016-04-01 21:26:03 +01:00
Eric Jimenez fa4b597614 Add additional tags to the angular.io dgeni package for the new api doc style proposal.
Closes #1030
2016-04-01 17:37:21 +01:00
Ward Bell 082932a210 docs: update to beta.13 2016-03-31 13:22:46 -07:00
Tero Parviainen 7f11a6ce05 docs(cb-ts-to-js): add cookbook about applying TypeScript examples to ES5
closes #893
2016-03-27 23:36:51 -07:00
Ward Bell a2cb80330a docs: update to beta-12 2016-03-23 21:39:13 -07:00
Ward Bell 639ca37de5 docs: update to beta-11
closes #987
also updated lifecycle-hooks/e2e-spec for changed hook calling sequence (not a bug; just a change)
2016-03-18 19:22:00 -07:00
Ward Bell 2929255bb4 chore: update es6-shim to v.0.35.0 per A2 issue #7618 2016-03-15 11:45:39 -07:00
Ward Bell 5f2148b4f4 docs(ts): update to A2 beta.9 2016-03-09 17:44:47 -08:00
Ward Bell 17aa278ddb docs: update to beta-8 2016-03-03 11:22:41 -08:00
Ward Bell 524ff05373 chore: add shims_for_IE.js to all index.html 2016-02-25 14:04:37 -08:00
Ward Bell 9a7294c25b docs:update sample to TS v.1.8.2 2016-02-25 13:20:11 -08:00
Ward Bell 8abb7085d5 docs(ts): update to beta.7 2016-02-20 19:17:14 -08:00
Jay Traband 3926d4202f chore: move jade fragments into separate _fragments subdirs.
closes #842
2016-02-15 13:31:08 -08:00
Ward Bell 3d992384c3 chore(devguide/ts): to beta.6 + typings + related doc updates 2016-02-12 00:56:22 -08:00
Naomi Black 9e43a4f425 dgeni(upgrade): add upgrade which was missing from api docs 2016-02-10 15:04:09 -08:00
Ward Bell 00d06ca50a chore: update to A2 beta.3
closes #805
2016-02-03 16:00:28 -08:00
Ward Bell 9f692ffb27 Update from beta.0 to beta.1 2016-01-28 15:35:53 -08:00
Peter Bacon Darwin 12e989da08 chore(doc-gen): include static members in the class template
Closes #761
2016-01-28 10:51:54 +00:00
Christoph Burgdorf 77db0755c8 docs(guide/server-communication): adds http chapter
closes #662
2016-01-25 23:28:36 -08:00
Ward Bell 17fe05b73d docs(homepage): examples conform to std + e2e tests
closes #740
2016-01-25 23:15:19 -08:00
Sebastian Müller e20f191429 fix(directives): remove dashCase pipe 2016-01-22 18:49:03 -08:00
Jay Traband 59204bfbc8 chore(tooling): Fix for jade shredding thrashing
closes #731
2016-01-21 22:32:01 -08:00
Jay Traband 45ac0ee37d docs(tooling): new mixin for sharing jade files
merges #725
2016-01-19 15:43:47 -08:00
Ward Bell 7ed0fce10d docs: add IE polyfills to all samples; update QS and Router to explain
closes #712
2016-01-17 20:32:59 -08:00
Ward Bell c7f58ee459 docs(router): incorporate Brian's comments; other fixes
closes #712
2016-01-17 20:32:15 -08:00
Peter Bacon Darwin c94ad87dd4 chore(doc-gen): add createDecoratorDocs processor
The createDecoratorDocs processor identifies docs of exports that actually
represent decorators and get useful information for them.

This commit also set up the rest of the generation to display these new
decorator docs with their own template and updates the API list so that
we can filter the docs by decorator docType.
2016-01-10 21:16:47 -08:00
Jay Traband 661f5fd89f chore: fix error with doc-shredder not recognizing missing json fragment files.
closes #672
2016-01-09 13:27:38 -08:00
Jay Traband 21ad7eff11 docs(copyright): Add Copyright and license info to each file in the plunker.
closes #671
2016-01-08 19:43:11 -08:00
Ward Bell a1c5d44468 docs: fix JS plunker generation for beta
closes #531
2015-12-15 13:04:51 -08:00
Ward Bell 75ad34afcd docs: flip tooling from a.55 to b.0
closes #530
2015-12-15 12:40:30 -08:00
Ward Bell 0b466a239d docs(*) migrate index.htmls for release
closes #528
2015-12-15 12:19:30 -08:00
Filipe Silva b05acd3b47 docs: update QuickStart and plunker generator to a.55; set QS to appear to use beta.0
closes #526
2015-12-15 11:20:59 -08:00
Peter Bacon Darwin 452e7e7729 chore(doc-gen): automatically update environment and version on the cheatsheet
Closes #515
2015-12-15 09:51:52 -08:00
Ward Bell bc74ee4ac3 docs(QuickStart): incorporate misko's suggestions/corrections
closes #502
2015-12-14 15:55:12 -08:00
Jay Traband e2f2ca61e6 chore(dev-tooling): small fixes and alpha.53
closes #486
add missing karma-test-shim.js
update test files
alpha.53
exclude example-config.json from plunkers
2015-12-12 20:25:19 -08:00
Ward Bell dbc3982aae docs(QuickStart): rewritten for 52 and latest recommendations
closes #472
2015-12-12 09:27:13 -08:00