6cd4b1b41c
build(aio): add `@nodoc` alias to the `@internal` tag ( #21024 )
...
The `@internal` tag prevents code items from appearing in the docs and the
typings files. You can now use `@nodoc` if you only want it to be excluded
from the docs and not the typings files.
Closes #20990
PR Close #21024
2018-01-05 14:59:59 -05:00
a693c5614c
ci: add router/testing to public API guard
2017-12-19 10:45:33 -08:00
e2b76bb386
build(aio): filter out ambiguous directives from auto code linking ( #20512 )
...
Closes #20466
PR Close #20512
2017-11-21 22:28:16 -06:00
ae0275e2dd
build(aio): do not store duplicate metadata aliases ( #20512 )
...
Having duplicates was causing the code auto-linking
to ignore `ngForm` directives.
PR Close #20512
2017-11-21 22:28:16 -06:00
ecce90718b
build(aio): better parsing of selectors as aliases for directives/components ( #20512 )
...
PR Close #20512
2017-11-21 22:28:16 -06:00
7c44637fbf
build(aio): tighten up code autolinking ( #20468 )
...
Do not match code "words" that are part of a hyphenated
string of characters: e.g. `platform-browser-dynamic` should
not auto-link `browser`.
Do not match code "words" that correspond to pipe names
but are not preceded by a pipe `|` character. E.g. `package.json` should
not auto link `json` to the `JsonPipe`.
Closes #20187
PR Close #20468
2017-11-16 16:20:03 -06:00
7e38f4fd1f
fix(aio): fix window title on Home page ( #20440 )
...
Using `display: none` on the `<h1>` causes `innerText` to not work as expected
and include the icon ligature (`link`) in the title. This caused the window
title on the angular.io Home page to appear as "Angular - link".
This commit fixes it by not generating anchors at all for headings with the
`no-anchor` class.
Fixes #20427
PR Close #20440
2017-11-15 18:25:58 -06:00
3997d97806
revert: feat(elements): implement `@angular/elements` #19469 ( #20152 )
...
This PR was merged without API docs and general rollout plan.
We can't release this as is in 5.1 without a plan for documentation, cli integration, etc.
2017-11-03 15:54:54 -07:00
ebfa204af0
feat(elements): set up the `elements` package
2017-11-02 16:09:09 -07:00
068348e9b1
build(aio): do not fail the initial doc-gen when running docs-watch
...
Checks that cause the doc-gen to fail were already disabled in `docs-watch`
for the doc-gen that runs when a file is changed.
Now these checks are also disabled for the initial doc-gen run.
closes #20038
2017-11-02 15:03:59 -07:00
1beab0da6a
build(aio): do not fail on bad examples when running `docs-watch`
2017-11-02 15:00:22 -07:00
3a03ff6b2d
build(aio): allow render-examples to complete even if examples are broken
...
By setting `renderExamples.ignoreBrokenExamples = true` the doc-gen will
not fail if there is something wrong with an example. Instead it will
just log a warning.
2017-11-02 15:00:22 -07:00
0355142737
build(aio): fail doc-gen if a code-example is badly formatted.
...
This will catch the problem that was missed in
https://github.com/angular/angular/pull/19845#issuecomment-338626662
2017-11-02 14:58:38 -07:00
9ab1f4a9c9
style(aio): fix docs linting issues ( #19702 )
...
These issues appeared after upgrade of eslint jasmine plugin
PR Close #19702
2017-11-01 15:24:46 -07:00
4abacb58f1
fix(aio): add service worker entrypoint to aio build ( #19875 )
...
Fixes #19838
PR Close #19875
2017-10-23 19:31:42 -04:00
dbe6cdad7e
build(aio): improve accessor rendering ( #19637 )
...
Includes an update to `dgeni-packages@0.22.0` which provides more info
about accessors if required.
PR Close #19637
2017-10-11 11:51:42 -07:00
8b571309ed
build(aio): append information about links in and out of docs ( #19583 )
...
Closes #19560
PR Close #19583
2017-10-10 17:06:51 -07:00
963a4d0dc8
build(aio): sort API list alphabetically ( #19566 )
...
Closes #19559
PR Close #19566
2017-10-09 14:42:52 -07:00
9783c92935
build(aio): fix various API rendering issues
...
Upgrading to dgeni-packages 0.21.4 gives us
access to more properties on the API docs, which
allows us to fix the following issues:
Closes #19450
Closes #19452
Closes #19456
2017-10-03 08:15:02 -07:00
ffceae0a01
refactor(aio): remove unnecessary `--` from yarn commands
2017-09-25 14:37:13 -07:00
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
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
4ae546be1f
build(aio): ensure decorators with shared interface types are found ( #19361 )
...
Closes #19358
2017-09-25 11:59:21 -07:00
4c73b52d5c
docs(aio): tidy up tooling documentation ( #18151 )
...
PR Close #18151
2017-09-21 10:00:37 -07:00
4530654501
docs(aio): high-level documentation of the `transforms` folder ( #18151 )
...
PR Close #18151
2017-09-21 10:00:36 -07:00
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
988b9f8378
build(aio): remove commented out code ( #19265 )
...
PR Close #19265
2017-09-20 12:36:14 -07:00
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
a2b50ec8c9
build(aio): do not render annotations block for directives
2017-09-12 13:56:21 -04:00
77d24afea3
build(aio): improve rendering of directive selectors
2017-09-12 13:55:54 -04:00
39386eadea
build(aio): do not render comments in decorators
...
Closes #18873
2017-09-12 13:52:02 -04:00
bd928f3dcc
build(aio): render metadata members from decorator ancestors
2017-09-08 17:04:36 -04:00
e78402dd4c
build(aio): render ancestor members in directives
...
See `CheckBoxRequiredValidator` for an example.
2017-09-08 17:04:28 -04:00
917d0870e8
build(aio): don't show constructor detail if there is none
2017-09-08 13:21:16 -04:00
3c480e4e63
build(aio): support rendering of constructor overloads in API docs ( #19042 )
...
Closes #18258
2017-09-06 10:14:02 -07:00
35bc1eb218
build(aio): render the `extends` ancestors of classes in API docs ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
dc7de0896c
build(aio): ensure dgeni can load all angular Typescript modules ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
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
cc2a4c41f9
build(aio): fix warning about missing `<h1>`
...
Fixes #17549
2017-07-31 13:40:07 -07:00
d71ae278ef
fix(aio): fix links to source for paths with symlinks
...
Fixes #18353
2017-07-28 15:28:59 -07:00
36faba1aab
fix(aio): add quote to module
2017-07-18 17:48:04 +01:00
c453b7bcfa
build(aio): fail doc-gen if referenced images are missing
2017-07-18 11:45:05 +01:00
758848961e
build(aio): abort doc-gen on dangling links
2017-07-18 11:45:05 +01:00
99b666614d
build(aio): abort doc-gen if an example is missing
...
Closes #16936
2017-07-18 11:45:05 +01:00
0bf0c35bca
build(aio): render type parameters of API function exports
...
Fixes #18123
2017-07-15 08:52:35 +01:00
db96c963a8
fix(aio): add <hr> in between overloads
2017-07-13 14:58:33 -07:00
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
a301dba68f
build(aio): improve API docs layout and styling
2017-07-13 12:16:20 -07:00
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
f06ce9adc8
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
Jason Aden
George Kalpakas
Igor Minar
Alex Rickabaugh
WilliamKoza