Pete Bacon Darwin
4bd9f53e8f
feat(docs-infra): rename tagdef: `@experimental` to `@publicApi` ( #26595 )
...
PR Close #26595
2018-10-19 14:35:52 -07:00
Pete Bacon Darwin
4c0ad5238e
build(docs-infra): display github links in CLI API docs ( #26515 )
...
This commit includes the following changes:
* CLI version information is read from the CLI package from which
we read the help files.
* CLI API pages now contain GH links
* line numbers are not shown in GH links, if the doc does not
have a truthy `startingLine` value. This allows us to remove
hard coded checks for `guide` pages
* content pages and CLI api docs no longer have a `startingLine`
* the hard-coded `packages` path segment has been removed from
the templates; instead we now only use the `realProjectRelativePath`.
* the `realProjectRelativePath` has been updated accordingly for API
and CLI API docs.
PR Close #26515
2018-10-19 11:12:54 -07:00
Pete Bacon Darwin
9e8903ada1
build(docs-infra): show github edit link on CLI overview ( #26515 )
...
PR Close #26515
2018-10-19 11:12:53 -07:00
Pete Bacon Darwin
b9bd95b3b2
build(docs-infra): break long CLI options onto two lines ( #26272 )
...
PR Close #26272
2018-10-19 11:07:30 -07:00
Pete Bacon Darwin
3f89aeb80a
build(docs-infra): update CLI option rendering ( #26272 )
...
PR Close #26272
2018-10-19 11:07:30 -07:00
Pete Bacon Darwin
6c530d3a85
build(docs-infra): render CLI arguments consistently ( #26272 )
...
In the command syntax, arguments are rendered as
`var`s enclosed in angle brackets. So this is now repeated
in the arguments table too.
PR Close #26272
2018-10-19 11:07:30 -07:00
George Kalpakas
d9d226087c
build(docs-infra): allow `""` as empty region in `{@example}` tags ( #26514 )
...
PR Close #26514
2018-10-18 09:54:17 -07:00
George Kalpakas
7bad1d356d
build(docs-infra): only render code example content in one place ( #26514 )
...
PR Close #26514
2018-10-18 09:54:17 -07:00
George Kalpakas
0add00a743
build(docs-infra): throw error if using `title` on code snippets ( #26514 )
...
Since #26396 , the `title` property is ignored and `header` should be
used instead for specifying a code snippet's header.
This commit ensures that we don't accidentally set `title` have it be
silently ignored.
PR Close #26514
2018-10-18 09:54:17 -07:00
William Marques
fc6dad40ac
fix(docs-infra): rename "title" by "header" to avoid unwanted tooltips ( #26396 )
...
Closes #26174
PR Close #26396
2018-10-17 11:05:29 -07:00
George Kalpakas
9e32dc7c95
build: upgrade `@types/jasminewd2` to 2.0.4 ( #26139 )
...
This commit also removes the extra jasminewd2 typings, since the changes
have been merged in the official typings with
DefinitelyTyped/DefinitelyTyped#28957.
PR Close #26139
2018-10-12 14:11:11 -07:00
Pete Bacon Darwin
ea20ae63d0
build(docs-infra): only show name in 'inherited from' section ( #26387 )
...
Closes #26181
PR Close #26387
2018-10-12 09:13:02 -07:00
George Kalpakas
67608a907e
build(docs-infra): make the git ref for cli command docs configurable ( #26391 )
...
PR Close #26391
2018-10-11 12:57:49 -07:00
Brandon Roberts
d1b7bb52e7
docs: add note for including polyfills for StackBlitz examples ( #25892 )
...
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
1312693f88
docs: add core-js polyfills for StackBlitz support ( #25892 )
...
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
72ff9c880c
docs: sync boilerplate configuration with Angular CLI RC2 ( #25892 )
...
Revers Jasmine version back to ~2.99.1
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
3060b3e29b
docs: bump Jasmine version, fix build scripts ( #25892 )
...
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
ee28b64d74
docs: add webpack-cli back in shared example dependencies ( #25892 )
...
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
1246ba53c7
docs: cleanup universal boilerplate scripts ( #25892 )
...
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
c29ff722a0
docs: add testing styles back to boilerplate configuration ( #25892 )
...
PR Close #25892
2018-10-09 17:04:20 -07:00
Brandon Roberts
f922808b8d
docs: update to latest Angular RC, CLI RC, and Jasmine releases ( #25892 )
...
PR Close #25892
2018-10-09 17:04:19 -07:00
Brandon Roberts
67435d456c
Revert "docs: add testing styles in index.html, remove additional configuration" ( #25892 )
...
This reverts commit 621d82a44c9d46f69f3296b302984f5949b8dee8.
PR Close #25892
2018-10-09 17:04:19 -07:00
Brandon Roberts
fbfce79b93
docs: add testing styles in index.html, remove additional configuration ( #25892 )
...
PR Close #25892
2018-10-09 17:04:19 -07:00
Brandon Roberts
2a14dfa4ba
docs: update shared example dependencies to Angular 7 and CLI 7 ( #25892 )
...
PR Close #25892
2018-10-09 17:04:19 -07:00
Pete Bacon Darwin
5977b72e9c
build(docs-infra): fix formatting of entry point export table ( #25768 )
...
Now that `list-table` cells are `pre` formatterd we must be careful
of what whitespace appears in text nodes.
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
7373da9b11
build(docs-infra): simplify property syntax rendering ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
783a682a7d
build(docs-infra): remove unused property table heading ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
d22418d417
build(docs-infra): add short description "See more" link ( #25768 )
...
If there is additional (non-short) description then add in a
link to the short description to take the reader there.
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
4b1fd98093
build(docs-infra): pluralize NgModule(s) heading as appropriate ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
935ef13096
build(docs-infra): improve directive selector rendering ( #25768 )
...
`:not(...)` blocks are now rendered as italic, while the
rest of the selector is bold.
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
f4b60588fb
build(docs-infra): move directive macros into memberHelpers.html ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
15dadb92ef
build(docs-infra): include directives etc in class descendants lists ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
ce06a75ebf
build(docs-infra): display inherited members on directives ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
9889276b15
build(docs-infra): directive inputs and outputs ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
d0f7eadc09
build(docs-infra): rename example template variable in directive pages ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
4b132c9848
build(docs-infra): remove class overview from directive pages ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
46729c76a0
build(docs-infra): improve directive selector rendering ( #25768 )
...
If the documentation contains a `@selectors` tag then the content of that
is used to describe the selectors of a directive.
Otherwise the selector string is split and each selector is listed as
a list item in an unordered list.
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
f22deb2e2d
build(docs-infra): improve directive API doc templates ( #25768 )
...
Closes #22790
Closes #25530
PR Close #25768
2018-10-01 09:36:32 -07:00
Ben Lesh
ffc6e199bf
build: RxJS updated to 6.3 ( #26087 )
...
PR Close #26087
2018-09-26 17:01:15 -07:00
Pete Bacon Darwin
f29b218060
feat(docs-infra): generate Angular CLI command reference ( #25363 )
...
PR Close #25363
2018-09-26 11:24:02 -07:00
Pete Bacon Darwin
b8422b41bb
build(docs-infra): fail doc-gen if a content rule fails ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin
8ac4dd6447
build(docs-infra): allow usage notes on decorator option properties ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin
3808416479
build(docs-infra): remove legacy jsdoc tag processing ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin
cee7448efc
build(docs-infra): add @nocollapse tag-def to prevent warning ( #26039 )
...
See https://github.com/angular/angular/blob/master/packages/compiler-cli/src/transformers/nocollapse_hack.ts
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin
7f1cace2a2
build(docs-infra): sort NgModule exports by id ( #26051 )
...
PR Close #26051
2018-09-21 17:00:03 -07:00
Pete Bacon Darwin
56c86c7e79
build(docs-infra): sort package exports by id ( #26051 )
...
Closes #26046
PR Close #26051
2018-09-21 17:00:03 -07:00
Pete Bacon Darwin
026b60cd70
build(docs-infra): expose deprecated status on items more clearly ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
Pete Bacon Darwin
cea2e0477c
fix(docs-infra): render security risk labels ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
Pete Bacon Darwin
96f9f03d25
build(docs-infra): improve search quality ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
Pete Bacon Darwin
9931bd7576
build(docs-infra): do not include license comment in first API doc ( #26050 )
...
The default dgeni config is to concatenate leading comments in front of API items.
In the case that you have an API item that starts a file with no import statements,
the license comment at the top of the file was being added to the front of the
API item's comment. SInce the license comment includes the `@license` tag
and the API item's comment did not start with `@description` the content of
the API item's comment was being put inside the `@license` tag, and no
description was being extracted from the API item's comment.
This commit updates to a version of dgeni-packages that has a switch to turn off
this concatenation, and then also configures this switch.
Closes #26045
PR Close #26050
2018-09-21 10:25:41 -07:00