4bd3e5f92f
build(aio): do not render "constructor()" heading in API docs ( #22380 )
...
Closes #22363
PR Close #22380
2018-02-27 07:07:16 -08:00
c10c831b8e
build(aio): render subclasses + see-also block in the main flow ( #22445 )
...
Closes #22386
PR Close #22445
2018-02-26 17:50:42 -08:00
1f599818bd
build(aio): fix rendering of callable and constructable interface members ( #22428 )
...
Closes #22136
PR Close #22428
2018-02-26 13:35:15 -08:00
5a32d7e36f
build(aio): render default value for optional parameters ( #22435 )
...
Closes #22134
PR Close #22435
2018-02-26 13:34:38 -08:00
1ea41d48d3
build(aio): render whether parameters are optional ( #22435 )
...
Closes #22134
PR Close #22435
2018-02-26 13:34:38 -08:00
25a43041d2
build(aio): group API members by type in overview ( #22438 )
...
Now the overview groups the members in the following order:
* static properties
* static methods
* constructor
* instance properties
* instance members
Closes #22132
PR Close #22438
2018-02-26 13:34:04 -08:00
7007f51c35
feat(aio): first pass API docs redesign ( #21874 )
...
Includes:
* display ToC for API docs
* update dgeni-packages to 0.24.1
* add floating sidebar in API docs
* add breadcrumbs and structured data for Google crawler
* improved rendering of method overloads
* properties rendered in a table
* params rendered with docs
* removal of outdated "infobox" from all API docs
PR Close #21874
2018-02-09 13:05:16 -08:00
c83c4168ca
build(aio): upgrade to dgeni-packages 0.24.0 ( #21802 )
...
This has two benefits:
* it prepares the way for the API docs update, which need parameter docs
* it doesn't incorrectly report dangling links for non-latin anchors
Closes #21306
PR Close #21802
2018-01-31 10:20:37 -08:00
a64af40c0b
build(aio): generate sitemap from the generated pages ( #21689 )
...
Closes #21684
PR Close #21689
2018-01-22 12:55:15 -08:00
b2e902deb4
fix(aio): fix code highlight in API docs templates ( #21630 )
...
Fixes #21108
PR Close #21630
2018-01-19 13:23:41 -08: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
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
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
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
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
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
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
be3352a084
build(aio): render grouped overloads
2017-07-13 12:16:20 -07:00
998049ec9b
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
470a7c6bcd
build(aio): use dedicated overview for decorator API docs
2017-07-11 11:44:05 +01:00
3abf208235
build(aio): update doc-gen templates
2017-07-11 11:44:05 +01:00
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
d5ce086089
build(aio): fix up API doc-gen templates
...
* Remove whitespace before type specifiers
* Generate `new` and `call` member info for interfaces
* Ensure that there is no double space after class names
2017-06-02 13:18:09 -04:00
cb2cb7c3bd
build(aio): display "call" and "new" members of interfaces in API docs
2017-05-31 08:45:50 +03:00
7b4a8d53a7
build(aio): remove "pure" property from pipe template ( #16655 )
...
This information is not relevant to users, right now.
Closes #16641
2017-05-09 15:44:10 -07:00
d27588b5fb
feat(aio): api label styles
...
- Moved info bar section in pipe template to be the first section to match other templates
- Fixed label styling for type label
- Added label styling for status label
2017-05-05 11:04:55 +01:00
8760bf7be4
build(aio): fix paths to template macros in overview-dump template
2017-05-03 13:30:11 -07:00
ea02073c84
build(aio): mark API docs as not having a TOC
2017-05-03 13:30:11 -07:00
b051d7ff48
build(aio): refactor API templates for clean start
2017-05-03 13:30:11 -07:00
04dc24820d
feat(aio): comment cleanup, API table styles
...
- API table styling
- Cleanup on resource page comments
2017-05-02 10:57:54 -07:00
235eb17cca
build(aio): improve info-bar template
...
The "npm module" and "NgModule" are now rendered correctly.
Closes #16055
2017-05-01 15:51:03 -07:00
bb52e22ecf
feat(aio): api pages styling
...
- Banner class code consolidation for API pages
- Set up temporary table of contents class and file
- API pages title styling
- Add color styling to doc-type listed on each API details page
- Classes and SCSS variables refactor
- Mobile optimization on headers, info-banner, and API pages
- API page table custom styling
- API Class Overview template code overview into table format
2017-04-26 14:31:54 +01:00
1762047bc0
build(aio): fix other dgeni templates
...
The function and interface templates were overriding the
wrong block.
2017-04-25 07:35:34 +01:00
9a4c8d543d
build(aio): fix rendering of Decorator API docs
...
The templates were a bit out and we were not merging the
correct properties.
Added some docs and tests for the processor.
Related to #16208
2017-04-25 07:35:34 +01:00
64ef69fb34
feat(aio): api page column layout
2017-04-25 06:51:04 +01:00
cf034f759a
feat(aio): api page styles
...
Changed description from h3 to h2 to match the other header
Created api page classes for consistent styling
Add styles for info-bar section
Wrapped pre tags for code not to go off of screen
2017-04-21 16:24:37 +01:00
Pete Bacon Darwin
George Kalpakas
WilliamKoza
Alex Rickabaugh
Stefanie Fluin