Alex Eagle
03d914a6c2
build: hide @angular/http for Angular v8 ( #29550 )
...
Currently our plan is to skip the publish, docgen, and update steps for this package.
During RC, we'll determine if the breaking change is too difficult for users, in which case we might restore the package for another major.
PR Close #29550
2019-04-02 10:55:31 -07:00
Brandon
12c9bd257d
docs: add new getting started guide ( #27684 )
...
PR Close #27684
2019-03-29 10:47:37 -07:00
Adam Plumer
6b6fdffc12
fixup! docs: update Universal guide ( #28296 )
...
PR Close #28296
2019-03-11 10:52:18 -07:00
Adam Plumer
a29ce57732
docs: migrate examples from @angular/http to @angular/common/http ( #28296 )
...
PR Close #28296
2019-03-11 10:52:17 -07:00
Alan Agius
d940b5541f
fix(docs-infra): boolean options default value is incorrect when it's undefined ( #27024 )
...
In the CLI when it's undefined it can mean `false`, or sometimes it will be overwritten by a runtime value.
PR Close #27024
2019-01-28 20:43:15 -08:00
WilliamKoza
e2c98fbe11
fix(docs-infra): change the key used to find out the cli section ( #28293 )
...
PR Close #28293
2019-01-24 15:41:44 -08:00
WilliamKoza
4c0104c846
fix(docs-infra): Add crossed through styling ( #28111 )
...
PR Close #28111
2019-01-14 10:45:46 -08:00
WilliamKoza
72f2428cd8
fix(docs-infra): change style of `deprecated` markers ( #28111 )
...
PR Close #28111
2019-01-14 10:45:46 -08:00
WilliamKoza
d577b8df75
fix(docs-infra): render `deprecated` markers for CLI command options ( #28111 )
...
fixes #27563
fixes #27423
PR Close #28111
2019-01-14 10:45:46 -08:00
Pete Bacon Darwin
cd51775390
build(docs-infra): render `@see` information in members ( #28069 )
...
Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.
PR Close #28069
2019-01-11 14:35:23 -08:00
Pete Bacon Darwin
18b6d580c5
fix(docs-infra): update overload rendering ( #24976 )
...
Based on the review here:
https://github.com/angular/angular/pull/24976#issuecomment-415535125
PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
03417df54e
build(docs-infra): display long overload parameter types as `object` ( #24976 )
...
In some overloads, the parameter type can be a large anonymous
object type.
This change displays such types as `object`. It is then up to the
documentation author to put more information about the type in the
method usage notes.
PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
61cd5f7c0f
build(docs-infra): fix individual API overload templates ( #24976 )
...
* Make individual overloads collapsible
* Show only the first overload expanded, rest collapsed
* Text changes to 'collapse all' once 'show all' is clicked
* Fix chevron/carrot rotation animation when overloads / overload item is expanded or collapsed
PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
68dfa04f8a
build(docs-infra): add method overload index ( #24976 )
...
PR Close #24976
2018-11-01 14:17:10 -07:00
Stefanie Fluin
6902977665
build(docs-infra): improve API overload templates ( #24976 )
...
PR Close #24976
2018-11-01 14:17:10 -07:00
Pete Bacon Darwin
d72d50d83e
build(docs-infra): move CLI API desciption higher up ( #26568 )
...
Closes #26556
PR Close #26568
2018-10-29 13:01:08 -04:00
Pete Bacon Darwin
07509da78d
build(docs-infra): ensure that CLI code blocks are not auto-linked ( #26675 )
...
Some of the text in CLI API docs were being auto-linked to API
pages. This was not correct, and in fact these blocks should not
have any auto links to Angular API at all.
Closes #26570
PR Close #26675
2018-10-26 18:09:20 -04:00
Pete Bacon Darwin
9ff8155cd9
build(docs-infra): mark code blocks to disable auto-linking ( #26675 )
...
You can now mark `<code>` blocks with a `no-auto-link` css class
to tell the code auto-linker to ignore this code block.
PR Close #26675
2018-10-26 18:09:20 -04:00
Pete Bacon Darwin
7c730fe5b3
build(docs-infra): include inherited members in search index ( #26676 )
...
Closes #23800
PR Close #26676
2018-10-26 13:16:33 -04:00
Pete Bacon Darwin
f233131974
build(docs-infra): refactor generateKeywords processor ( #26676 )
...
PR Close #26676
2018-10-26 13:16:32 -04:00
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
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
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
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