George Kalpakas
ffceae0a01
refactor(aio): remove unnecessary `--` from yarn commands
2017-09-25 14:37:13 -07:00
Pete Bacon Darwin
adb0b761f1
build(aio): add metadata aliases for directives, components and pipes ( #19317 )
...
This change will enable people to link to the API docs via their selectors
or names, as used in a template.
Since the selectors can be quite complex we are not able to get 100%
accuracy.
Closes #16787
2017-09-25 12:00:05 -07:00
Pete Bacon Darwin
97e02c2fa0
build(aio): render class/interface "descendants" in API docs ( #19343 )
...
For classes, the tree of subclasses is rendered, recursively.
For interfaces, the descendants are separated into child interfaces, which
extend the interface, and classes, which implement the interface.
Closes #19306
2017-09-25 11:59:44 -07:00
Pete Bacon Darwin
4ae546be1f
build(aio): ensure decorators with shared interface types are found ( #19361 )
...
Closes #19358
2017-09-25 11:59:21 -07:00
Peter Bacon Darwin
4c73b52d5c
docs(aio): tidy up tooling documentation ( #18151 )
...
PR Close #18151
2017-09-21 10:00:37 -07:00
Peter Bacon Darwin
4530654501
docs(aio): high-level documentation of the `transforms` folder ( #18151 )
...
PR Close #18151
2017-09-21 10:00:36 -07:00
Peter Bacon Darwin
381e680758
build(aio): improve error message for ignored example files ( #19265 )
...
Addresses https://github.com/angular/angular/pull/18707#issuecomment-330396771
PR Close #19265
2017-09-20 12:36:14 -07:00
Peter Bacon Darwin
988b9f8378
build(aio): remove commented out code ( #19265 )
...
PR Close #19265
2017-09-20 12:36:14 -07:00
Peter Bacon Darwin
9ab9437319
build(aio): auto-link more code items
...
We now parse all code blocks, after they have been rendered by dgeni
and insert links to API docs that match "words" in the code.
2017-09-12 13:58:43 -04:00
Peter Bacon Darwin
a2b50ec8c9
build(aio): do not render annotations block for directives
2017-09-12 13:56:21 -04:00
Peter Bacon Darwin
77d24afea3
build(aio): improve rendering of directive selectors
2017-09-12 13:55:54 -04:00
Peter Bacon Darwin
39386eadea
build(aio): do not render comments in decorators
...
Closes #18873
2017-09-12 13:52:02 -04:00
Peter Bacon Darwin
bd928f3dcc
build(aio): render metadata members from decorator ancestors
2017-09-08 17:04:36 -04:00
Peter Bacon Darwin
e78402dd4c
build(aio): render ancestor members in directives
...
See `CheckBoxRequiredValidator` for an example.
2017-09-08 17:04:28 -04:00
Peter Bacon Darwin
917d0870e8
build(aio): don't show constructor detail if there is none
2017-09-08 13:21:16 -04:00
Pete Bacon Darwin
3c480e4e63
build(aio): support rendering of constructor overloads in API docs ( #19042 )
...
Closes #18258
2017-09-06 10:14:02 -07:00
Peter Bacon Darwin
35bc1eb218
build(aio): render the `extends` ancestors of classes in API docs ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
Peter Bacon Darwin
dc7de0896c
build(aio): ensure dgeni can load all angular Typescript modules ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
Peter Bacon Darwin
b8a3736275
build(aio): do not auto-link code elements already inside a link ( #18776 )
...
Closes #18769
PR Close #18776
2017-08-18 17:13:16 -05:00
Georgios Kalpakas
cc2a4c41f9
build(aio): fix warning about missing `<h1>`
...
Fixes #17549
2017-07-31 13:40:07 -07:00
Georgios Kalpakas
d71ae278ef
fix(aio): fix links to source for paths with symlinks
...
Fixes #18353
2017-07-28 15:28:59 -07:00
WilliamKoza
36faba1aab
fix(aio): add quote to module
2017-07-18 17:48:04 +01:00
Peter Bacon Darwin
c453b7bcfa
build(aio): fail doc-gen if referenced images are missing
2017-07-18 11:45:05 +01:00
Peter Bacon Darwin
758848961e
build(aio): abort doc-gen on dangling links
2017-07-18 11:45:05 +01:00
Peter Bacon Darwin
99b666614d
build(aio): abort doc-gen if an example is missing
...
Closes #16936
2017-07-18 11:45:05 +01:00
Peter Bacon Darwin
0bf0c35bca
build(aio): render type parameters of API function exports
...
Fixes #18123
2017-07-15 08:52:35 +01:00
Alex Rickabaugh
db96c963a8
fix(aio): add <hr> in between overloads
2017-07-13 14:58:33 -07:00
Peter Bacon Darwin
ffda3e41e0
build(aio): simplify the primary overload's anchor
...
The primary link to a member should simply be its name, and not require
the parameter list.
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
a301dba68f
build(aio): improve API docs layout and styling
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
04f3a4a7a5
build(aio): fix githubLinks line numbers
...
The API docs have changed. The line numbers are now found in
`startingLine` and `endingLine` properties rather than the `location`
property, which moved into the `fileInfo` property anyway.
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
f06ce9adc8
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
be3352a084
build(aio): render grouped overloads
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
998049ec9b
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
e8bbf86e66
build(aio): add terms from heading to the search index
2017-07-11 15:04:37 +01:00
Peter Bacon Darwin
3a0886dc12
build(aio): capture all the headings from a doc in the vFile.headings property
2017-07-11 15:04:37 +01:00
Peter Bacon Darwin
d52ab8e2c9
build(aio): fix matchUpDirectiveDecorators processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
df7b875f6c
build(aio): fix mergeDecoratorDocs processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
470a7c6bcd
build(aio): use dedicated overview for decorator API docs
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
3abf208235
build(aio): update doc-gen templates
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
92c18d167e
build(aio): fix mergeDecoratorDocs processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
99b38f52cb
build(aio): fix matchUpDirectiveDecorators processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
633ec30291
build(aio): fix test description
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
57cfcb0830
build(aio): refactor filterMemberDocs to be more general
...
Now it also filters function-overloads, hence the name change.
2017-07-11 11:44:05 +01:00
Suguru Inatomi
b3d90365b6
fix(aio): add new common/http package into API list
2017-07-10 12:23:47 +01:00
Victor Berchet
c723d42d0a
refactor: fix typos ( #18000 )
2017-07-07 16:55:17 -07:00
Peter Bacon Darwin
1d93cf2e85
build(aio): ensure all doc tests are run
...
It is not possible to run all the docs tests directly via the jasmine CLI.
Instead we now have a small script that will run jasmine via its library.
2017-06-21 13:51:15 -07:00
Peter Bacon Darwin
3fb98fe4ea
build(aio): do not recurse node_modules when loading examples in doc-gen
2017-06-21 13:51:15 -07:00
Peter Bacon Darwin
12452d4ab4
build(aio): increase docs integration test timeouts
...
The API docs tests have very variable run times, depending
upon the build environment.
This change doubles their test timeout values to prevent
false-negative failures.
2017-06-13 11:56:45 +01:00
George Kalpakas
65d49d5c94
fix(aio): temporarily remove link to source from the API pages ( #17371 )
...
We need to come up with a better design (possibly involving an icon button) to
link to the source code (for viewing and/or editing).
Fixes #17254
2017-06-09 14:14:39 -07:00
Peter Bacon Darwin
3db6b6ca7a
build(aio): ignore example files that are gitignored
...
Rather than hard coding excludes into the dgeni config,
use the fact that we are already ignoring the boilerplate
and generated files via the .gitignore file.
2017-06-09 14:33:21 +01:00