b9bd95b3b2
build(docs-infra): break long CLI options onto two lines ( #26272 )
...
PR Close #26272
2018-10-19 11:07:30 -07:00
3f89aeb80a
build(docs-infra): update CLI option rendering ( #26272 )
...
PR Close #26272
2018-10-19 11:07:30 -07:00
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
d9d226087c
build(docs-infra): allow `""` as empty region in `{@example}` tags ( #26514 )
...
PR Close #26514
2018-10-18 09:54:17 -07:00
7bad1d356d
build(docs-infra): only render code example content in one place ( #26514 )
...
PR Close #26514
2018-10-18 09:54:17 -07:00
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
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
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
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
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
7373da9b11
build(docs-infra): simplify property syntax rendering ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
783a682a7d
build(docs-infra): remove unused property table heading ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
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
4b1fd98093
build(docs-infra): pluralize NgModule(s) heading as appropriate ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
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
f4b60588fb
build(docs-infra): move directive macros into memberHelpers.html ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
15dadb92ef
build(docs-infra): include directives etc in class descendants lists ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
ce06a75ebf
build(docs-infra): display inherited members on directives ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
9889276b15
build(docs-infra): directive inputs and outputs ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
d0f7eadc09
build(docs-infra): rename example template variable in directive pages ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
4b132c9848
build(docs-infra): remove class overview from directive pages ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
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
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
f29b218060
feat(docs-infra): generate Angular CLI command reference ( #25363 )
...
PR Close #25363
2018-09-26 11:24:02 -07:00
b8422b41bb
build(docs-infra): fail doc-gen if a content rule fails ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
8ac4dd6447
build(docs-infra): allow usage notes on decorator option properties ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
3808416479
build(docs-infra): remove legacy jsdoc tag processing ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
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
7f1cace2a2
build(docs-infra): sort NgModule exports by id ( #26051 )
...
PR Close #26051
2018-09-21 17:00:03 -07:00
56c86c7e79
build(docs-infra): sort package exports by id ( #26051 )
...
Closes #26046
PR Close #26051
2018-09-21 17:00:03 -07:00
026b60cd70
build(docs-infra): expose deprecated status on items more clearly ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
cea2e0477c
fix(docs-infra): render security risk labels ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
96f9f03d25
build(docs-infra): improve search quality ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
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
b94436d86c
build(docs-infra): process and render ngmodule exports ( #25734 )
...
All directives and pipes must now be tagged with one ore more
public NgModule, from which they are exported.
If an item is exported transitively via a re-exported internal NgModule
then it may be that the item appears to be exported from more than
one public NgModule. For example, there are shared directives that
are exported in this way from `FormsModule` and `ReactiveFormsModule`.
The doc-gen will error and fail if a directive or pipe is not tagged correctly.
NgModule pages now list all the directives and pipes that are exported from it.
Directive and Pipe pages now list any NgModule from which they are exported.
Packages also now list any NgModules that are contained - previously they were
missed.
PR Close #25734
2018-09-19 16:18:24 -07:00
bc5cb8153e
build(docs-infra): separate NgModules from Classes in API docs ( #25734 )
...
PR Close #25734
2018-09-19 16:18:24 -07:00
34b848ad51
build(docs-infra): remove unused info-bar API template ( #25734 )
...
PR Close #25734
2018-09-19 16:18:24 -07:00
4a04ab8823
build(docs-infra): do not render internals in package API pages ( #25723 )
...
Closes #24493
PR Close #25723
2018-09-05 09:28:05 -07:00
d539122466
refactor(docs-infra): refactor templates ( #24378 )
...
PR Close #24378
2018-08-31 09:42:10 -07:00
b89a7dd4a2
fix(docs-infra): show "suggest edits" only for /guide and /tutorial dirs ( #24378 )
...
PR Close #24378
2018-08-31 09:42:10 -07:00
9533cc9809
feat(docs-infra): add "suggest edits" feature to all docs ( #24378 )
...
PR Close #24378
2018-08-31 09:42:10 -07:00
b1902db0cb
build(docs-infra): render all overloads if they are abstract ( #25670 )
...
In an overloaded method, the overload with the function body is the
actual method doc, and this doc is not included in the list of "additional"
overloads.
Moreover, the logic (all in dgeni-packages) is that if none of the items
has a body then we use the first overload as the actual method doc.
In the case of abstract methods, none of the methods have a body. So we
have a situation where the overloads collection does not contain the first
abstract method, even though it is not the "implementation" of the method.
Therefore we need to still render it.
Closes #25610
PR Close #25670
2018-08-27 18:19:08 -04:00
a081d207f8
build(docs-infra): remove "annotations" section from API pages ( #25677 )
...
PR Close #25677
2018-08-27 18:18:41 -04:00
c13901f4c8
build(docs-infra): remove stability labels from API docs ( #25453 )
...
PR Close #25453
2018-08-14 13:17:15 -07:00
6a2130117f
build(docs-infra): clean up API package template ( #25453 )
...
PR Close #25453
2018-08-14 13:17:15 -07:00
4e45f2c481
build(docs-infra): include packages in API template breadcrumbs ( #25453 )
...
PR Close #25453
2018-08-14 13:17:15 -07:00
78f477652e
build(docs-infra): change breadcrumb delimiter to `>` ( #25453 )
...
PR Close #25453
2018-08-14 13:17:15 -07:00
edef58f466
build(docs-infra): ensure all API headings are sentence cased ( #24949 )
...
Closes #24880
PR Close #24949
2018-07-23 08:43:07 -07:00
3cd9645daa
fix(docs-infra): fix table header layout in API pages ( #24919 )
...
PR Close #24919
2018-07-20 10:48:42 -07:00
d8c828c9b1
build(docs-infra): implement the 'package' API template ( #24631 )
...
PR Close #24631
2018-07-13 19:45:54 -04:00
Pete Bacon Darwin
George Kalpakas
William Marques
Martin Sikora