Pete Bacon Darwin
9f877f4416
build(docs-infra): ensure stability is computed before the API list ( #24356 )
...
Previously the API list was being generated before the stability had
been computed. This meant that the API list page showed no API docs
when filtering by `stable` stability status.
Closes #24329
PR Close #24356
2018-06-08 13:33:32 -07:00
Pete Bacon Darwin
700e55ce14
build(docs-infra): log warning rather than error if content errors are not fatal ( #24320 )
...
PR Close #24320
2018-06-06 10:25:04 -07:00
Pete Bacon Darwin
68d37ef0c1
build(aio): ensure the correct decorator properties are merged ( #24289 )
...
Previously only the `description` and `usageNotes` were being copied over
from the call-member of the decorator interface. Important properties such
as `shortDescription` were missed.
These are now added and the code has been refactored to make it simpler and
clearer to update which properties get copied as the requirements change.
PR Close #24289
2018-06-06 10:23:47 -07:00
Zhicheng Wang
8136953a09
Merge branch 'en-master' into aio
...
# Conflicts:
# aio/content/examples/dynamic-component-loader/src/app/ad-banner.component.ts
# aio/content/examples/reactive-forms/src/app/hero-list/hero-list.component.ts
# aio/content/examples/upgrade-module/src/systemjs.config.1.js
# aio/content/guide/aot-compiler.md
# aio/content/guide/architecture-components.md
# aio/content/guide/architecture-modules.md
# aio/content/guide/architecture-next-steps.md
# aio/content/guide/architecture-services.md
# aio/content/guide/architecture.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/cheatsheet.md
# aio/content/guide/comparing-observables.md
# aio/content/guide/component-styles.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/docs-style-guide.md
# aio/content/guide/dynamic-component-loader.md
# aio/content/guide/elements.md
# aio/content/guide/glossary.md
# aio/content/guide/hierarchical-dependency-injection.md
# aio/content/guide/http.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/npm-packages.md
# aio/content/guide/observables.md
# aio/content/guide/providers.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/releases.md
# aio/content/guide/router.md
# aio/content/guide/service-worker-config.md
# aio/content/guide/service-worker-devops.md
# aio/content/guide/service-worker-getting-started.md
# aio/content/guide/service-worker-intro.md
# aio/content/guide/setup.md
# aio/content/guide/singleton-services.md
# aio/content/guide/styleguide.md
# aio/content/guide/testing.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/universal.md
# aio/content/guide/updating.md
# aio/content/guide/upgrade.md
# aio/content/marketing/features.html
# aio/content/navigation.json
# aio/content/tutorial/toh-pt0.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/package.json
# aio/src/app/documents/document.service.ts
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
# aio/src/app/shared/toc.service.ts
# aio/tools/transforms/templates/api/base.template.html
# aio/yarn.lock
2018-05-15 23:26:31 +08:00
Pete Bacon Darwin
02acb5e3e5
build(aio): improve `enum` API rendering ( #23872 )
...
* The member details section is now called "Members", rather
than "Properties".
* The property table now displays appropriate table headings:
"Member", "Value", "Description".
* The "Value" column is not shown if none of the members have
a value.
Closes #22678
PR Close #23872
2018-05-14 10:37:42 -07:00
Pete Bacon Darwin
a2e8b3a6a8
build(aio): ensure usageNotes are copied into decorator API docs ( #23901 )
...
PR Close #23901
2018-05-14 10:35:33 -07:00
Pete Bacon Darwin
d889f57ae2
build(aio): display types of API const docs correctly ( #23850 )
...
Previously these docs always displayed `any` as the type
of the const export. Now the type is computed correctly from
the declared type or initializer of the constant.
PR Close #23850
2018-05-11 16:44:50 -04:00
Pete Bacon Darwin
61170856ee
build(aio): include `navigation.json` changes in docs-watch ( #23698 )
...
Closes #23582
PR Close #23698
2018-05-09 11:45:18 -07:00
Pete Bacon Darwin
aae437cb1e
build(aio): implement rules to prevent short parameter names ( #22759 )
...
PR Close #22759
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
fa11d7822c
build(aio): create minLength content rule ( #22759 )
...
This rule can be used to ensure that properties contain a minimum
number of characters.
PR Close #22759
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
1619160c8a
build(aio): implement rules to prevent headings in content ( #22759 )
...
* No headings are allowed in `description` and `shortDescription`
* Only heading level 3 is allowed in `usageNotes`
PR Close #22759
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
7a8c58162c
build(aio): create noMarkdownHeadings content rule ( #22759 )
...
This content rule can check what markdown headings
appear in content properties.
PR Close #22759
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
e0ae74d40e
build(aio): add checkContentRules processor ( #22759 )
...
This processor will enable us to write rules about
how the content should appear, such as:
* no headings in markdown content
* only one sentence per line
* no single character parameter names
* etc.
PR Close #22759
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
381da1af45
build(aio): move "optional" and "default" to end of param description ( #23062 )
...
PR Close #23062
2018-04-05 09:25:15 -07:00
Pete Bacon Darwin
5b6e59cfb3
build(aio): fail the doc-gen if the nav is invalid ( #23175 )
...
PR Close #23175
2018-04-04 14:32:14 -07:00
Veres Lajos
de90314304
style: typos fixed - https://github.com/vlajos/misspell-fixer ( #22975 )
...
PR Close #22975
2018-03-27 14:51:53 -04:00
Zhicheng Wang
b433d2148c
fix: change some angular.io to angular.cn
2018-03-26 16:34:57 +08:00
Zhicheng Wang
67cb21e6c1
fix: 翻译完了服务端渲染部分
2018-03-22 10:52:52 +08:00
Andrew Seguin
22b96b9690
feat(elements): add support for creating custom elements ( #22413 )
...
PR Close #22413
2018-03-16 12:39:07 -07:00
Pete Bacon Darwin
19e6b8dad5
build(aio): fix `addNotYetDocumentedProperty` processor ( #22770 )
...
It was running too late and so was being confused by the
description being split into `shortDescription` and `description`
properties.
Closes #22748
PR Close #22770
2018-03-15 11:37:31 -07:00
Pete Bacon Darwin
d509bd6849
build(aio): improve the API Pipe pages ( #22702 )
...
This change adds:
* an impure badge for Pipes that are marked as `pure: false`
* a pipe specific overview that shows the syntax for using a pipe in a template.
* an "input value" section describing the type of the value that the pipe expects.
* a "pipe params" section describing any additional params that a pipe expects.
PR Close #22702
2018-03-14 14:21:11 -07:00
Pete Bacon Darwin
6f0dad1710
build(aio): render doc-gen issues in overview dump ( #22675 )
...
Related to #22138
PR Close #22675
2018-03-14 10:20:30 -07:00
Pete Bacon Darwin
48636f3e85
build(aio): compute stability and deprecate `@stable` tag ( #22674 )
...
Closes #22635
PR Close #22674
2018-03-13 19:55:00 -07:00
Pete Bacon Darwin
cd58c0a6d9
build(aio): remove unwanted overview headings ( #22681 )
...
PR Close #22681
2018-03-12 11:23:47 -07:00
Pete Bacon Darwin
38fef1588d
build(aio): move "see also" block to export-base template ( #22681 )
...
This makes it easier for all the API docs to display "see also" links
in a consitent manner.
PR Close #22681
2018-03-12 11:23:46 -07:00
Alex Eagle
1e6cc42a01
test: migrate remaining public-api tests to Bazel ( #22639 )
...
We now create npm packages to cover all the public api assertions in tools/public_api_guard.
We no longer depend on ts-api-guardian from npm - it is now stale since the repository was archived.
There is no longer a gulp task to enforce or accept the public API, this is in CircleCI as part of running all bazel test targets.
PR Close #22639
2018-03-09 09:11:40 -08:00
Zhicheng Wang
d24f7c74f2
fix: 一级标题没有隐藏原始标题
...
fix: 中文标题的 id 应该只按照英文版生成,英文内容不再设置 id
2018-03-08 12:47:55 +08:00
Zhicheng Wang
8af121ee8f
翻译文档首页
2018-03-08 09:28:04 +08:00
Pete Bacon Darwin
b3d1761825
build(aio): compute and display short descriptions in methods ( #22583 )
...
Previously only export docs were displaying a short description.
Now methods in classes and interfaces also compute and render
the short description.
Closes #22500
PR Close #22583
2018-03-06 11:05:21 -08:00
Pete Bacon Darwin
8ea4c57174
fix(aio): reposition and shrink the API badges ( #22570 )
...
Closes #22130
PR Close #22570
2018-03-05 21:25:09 -08:00
Pete Bacon Darwin
58932c7f38
build(aio): indicate whether properties are read-only in API pages ( #22584 )
...
PR Close #22584
2018-03-05 10:15:37 -08:00
Pete Bacon Darwin
5bb9f64218
fixup! feat(aio): allow template to position embedded ToC ( #22565 )
...
PR Close #22565
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
405d97431f
fixup! feat(aio): allow template to position embedded ToC ( #22565 )
...
PR Close #22565
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
41064fcb36
fix(aio): reposition and simplify github links ( #22565 )
...
Closes #22379
PR Close #22565
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
b80fd6be58
build(aio): render whether API classes and members are abstract ( #22563 )
...
Closes #22537
PR Close #22563
2018-03-05 10:13:43 -08:00
Pete Bacon Darwin
b64139650c
build(aio): class API template once again extends export-base ( #22534 )
...
PR Close #22534
2018-03-05 10:12:55 -08:00
Pete Bacon Darwin
1d2bdcb4d0
build(aio): render param descriptions for function exports ( #22534 )
...
Closes #22501
PR Close #22534
2018-03-05 10:12:55 -08:00
Pete Bacon Darwin
0e311e3918
build(aio): improve accuracy of code auto-linking ( #22494 )
...
The new version of `dgeni-packages/typescript` no longer strips
out "namespaces" from types, which was part of the problem of
not autolinking correctly to `HttpEventType.Response`.
Another part of the problem was that we did not include `.`
characters when matching potential code blocks for auto-linking,
which precluded properties of enums from being linked.
Finally, members we not being given a `path` property, which is
needed to effectively autolink to them. This is now set in
the `simplifyMemberAnchors` processor.
Closes #21375
PR Close #22494
2018-03-01 08:11:19 -08:00
Pete Bacon Darwin
997b30a093
build(aio): move link disambiguation from `getLinkInfo` to `getDocFromAlias` ( #22494 )
...
The disambiguation needs to be done earlier so that the auto-link-code
post-processor can benefit from it.
PR Close #22494
2018-03-01 08:11:19 -08:00
Pete Bacon Darwin
94707fe795
build(aio): initialise `exampleMap` correctly ( #22502 )
...
The `exampleMap` needs to hold an hash object for each
of the `collectExamples.exampleFolders` paths.
Previously these hash objects were only created if there
was actually an example file the hash's respective
example folder. This could cause crashes during
`yarn docs-watch` (and so also `yarn sync-and-serve`)
if no examples were read in for a particular run of
the doc-gen.
PR Close #22502
2018-03-01 08:10:15 -08:00
Pete Bacon Darwin
7d65356ae3
build(aio): add `@usageNotes` tag def for API docs ( #22401 )
...
PR Close #22401
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
11f30fc351
style(aio): add newline between test blocks ( #22401 )
...
PR Close #22401
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
b107131f8a
build(aio): split the description property in API docs ( #22401 )
...
* The first paragraph is now split off into the `shortDescription` property.
* Usage of `howToUse` and `whatItDoes` have been updated.
* The "Overview" heading for class is removed as it is self-evident
* The original horizontal rule styling below the main heading is removed as not part of the new design
Closes #22385
PR Close #22401
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
b924ce3a62
build(aio): add processor to migrate legacy tags `@whatItDoes` and `@howToUse` ( #22401 )
...
See https://github.com/angular/angular/issues/22135#issuecomment-367632372
PR Close #22401
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
e75f0cee18
build(aio): deprecate `@howToUse` and `@whatItDoes` tags ( #22401 )
...
See https://github.com/angular/angular/issues/22135#issuecomment-367632372
PR Close #22401
2018-02-28 10:43:27 -08:00
Zhicheng Wang
c08a3830df
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/architecture.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/change-log.md
# aio/content/guide/component-styles.md
# aio/content/guide/deployment.md
# aio/content/guide/forms.md
# aio/content/guide/glossary.md
# aio/content/guide/http.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule.md
# aio/content/guide/pipes.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/router.md
# aio/content/guide/security.md
# aio/content/guide/set-document-title.md
# aio/content/guide/setup-systemjs-anatomy.md
# aio/content/guide/setup.md
# aio/content/guide/testing.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/upgrade.md
# aio/content/marketing/docs.md
# aio/content/marketing/features.html
# aio/content/marketing/resources.json
# aio/content/navigation.json
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
2018-02-28 13:13:29 +08:00
Pete Bacon Darwin
83b32a0a0a
build(aio): render heading anchors on the right
...
This approach simplifies the styling needed considerably.
Previously, we had to make room on the left for heading that
are in visual containers. Also we had to apply a `float:right`
when on narrow screens as the gutter not available then.
This float didn't render nicely if the heading text was longer
than could be rendered on a single line.
Closes #22131
2018-02-27 18:32:32 -08:00
Zhicheng Wang
1531b0610d
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/attribute-directives.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/component-interaction.md
# aio/content/guide/component-styles.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/displaying-data.md
# aio/content/guide/form-validation.md
# aio/content/guide/forms.md
# aio/content/guide/glossary.md
# aio/content/guide/http.md
# aio/content/guide/i18n.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule.md
# aio/content/guide/npm-packages.md
# aio/content/guide/pipes.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/structural-directives.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/marketing/index.html
# aio/content/navigation.json
# aio/content/tutorial/index.md
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/src/app/embedded/api/api-list.component.ts
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
# aio/src/app/layout/footer/footer.component.html
# aio/src/app/layout/toc/toc.component.html
# aio/src/app/search/search.service.ts
# aio/src/styles/1-layouts/_marketing-layout.scss
# aio/yarn.lock
2018-02-28 08:08:59 +08:00
George Kalpakas
142117f6bb
fix(aio): do not show Properties/Methods sections if only internal members ( #22471 )
...
PR Close #22471
2018-02-27 15:17:22 -08:00
George Kalpakas
d100f1b187
build(aio): fix API docs breadcrumbs ( #22446 )
...
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.
Fixes #22387
Closes #22437
PR Close #22446
2018-02-27 07:08:07 -08:00
Pete Bacon Darwin
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
Pete Bacon Darwin
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
Pete Bacon Darwin
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
Pete Bacon Darwin
5a32d7e36f
build(aio): render default value for optional parameters ( #22435 )
...
Closes #22134
PR Close #22435
2018-02-26 13:34:38 -08:00
Pete Bacon Darwin
1ea41d48d3
build(aio): render whether parameters are optional ( #22435 )
...
Closes #22134
PR Close #22435
2018-02-26 13:34:38 -08:00
Pete Bacon Darwin
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
George Kalpakas
978f97cc59
test(aio): increase `docs-test` timeouts to prevent flakes on Travis ( #22261 )
...
PR Close #22261
2018-02-16 14:46:23 -08:00
Pete Bacon Darwin
fbef94a8ee
feat(aio): enable data driven homepage announcements ( #22043 )
...
PR Close #22043
2018-02-09 13:10:11 -08:00
Pete Bacon Darwin
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
Pete Bacon Darwin
71ea931df5
build(aio): blacklist unwanted URLs from the generated sitemap.xml ( #22061 )
...
Closes #22017
PR Close #22061
2018-02-07 12:02:01 -08:00
Pete Bacon Darwin
9a0700f5bd
build(aio): add API static members to search index ( #21988 )
...
Previously searching for `compose` did not include `Validators`
in the search results because we were not including all the
`static` members of API docs in the index.
PR Close #21988
2018-02-05 13:00:47 -08:00
Pete Bacon Darwin
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
Jesus Rodriguez
1a75934cc0
build(aio): migrate plunker to stackblitz ( #20165 )
...
PR Close #20165
2018-01-23 21:30:27 -08:00
Pete Bacon Darwin
a64af40c0b
build(aio): generate sitemap from the generated pages ( #21689 )
...
Closes #21684
PR Close #21689
2018-01-22 12:55:15 -08:00
George Kalpakas
b2e902deb4
fix(aio): fix code highlight in API docs templates ( #21630 )
...
Fixes #21108
PR Close #21630
2018-01-19 13:23:41 -08:00
Pete Bacon Darwin
d6ba9f9fb4
build(aio): move file cleaning to later in the doc gen ( #21540 )
...
Previously the generated files were cleaned out before
doc-gen began (via a yarn pre-script). This can cause a
race condition in the CLI server, which prevents the new
generated files from being picked up.
Now we delay the cleaning until the last minute to ensure
that they ar still picked up by the webpack server.
PR Close #21540
2018-01-16 07:10:30 -08:00
Peter Bacon Darwin
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
Jason Aden
a693c5614c
ci: add router/testing to public API guard
2017-12-19 10:45:33 -08:00
Peter Bacon Darwin
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
Peter Bacon Darwin
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
Peter Bacon Darwin
ecce90718b
build(aio): better parsing of selectors as aliases for directives/components ( #20512 )
...
PR Close #20512
2017-11-21 22:28:16 -06:00
Peter Bacon Darwin
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
George Kalpakas
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
Igor Minar
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
George Kalpakas
ebfa204af0
feat(elements): set up the `elements` package
2017-11-02 16:09:09 -07:00
Peter Bacon Darwin
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
Peter Bacon Darwin
1beab0da6a
build(aio): do not fail on bad examples when running `docs-watch`
2017-11-02 15:00:22 -07:00
Peter Bacon Darwin
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
Peter Bacon Darwin
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
Peter Bacon Darwin
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
Alex Rickabaugh
4abacb58f1
fix(aio): add service worker entrypoint to aio build ( #19875 )
...
Fixes #19838
PR Close #19875
2017-10-23 19:31:42 -04:00
Peter Bacon Darwin
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
Peter Bacon Darwin
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
Peter Bacon Darwin
963a4d0dc8
build(aio): sort API list alphabetically ( #19566 )
...
Closes #19559
PR Close #19566
2017-10-09 14:42:52 -07:00
Peter Bacon Darwin
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
Zhicheng Wang
d7fd581c37
Merge branch 'master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/browser-support.md
# aio/content/guide/form-validation.md
# aio/content/guide/i18n.md
# aio/content/guide/pipes.md
# aio/content/guide/router.md
# aio/content/guide/set-document-title.md
# aio/content/guide/structural-directives.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/marketing/resources.json
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
2017-10-01 13:22:33 +08:00
George Kalpakas
ffceae0a01
refactor(aio): remove unnecessary `--` from yarn commands
2017-09-25 14:37:13 -07:00
Pete Bacon Darwin
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
Pete Bacon Darwin
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
Pete Bacon Darwin
4ae546be1f
build(aio): ensure decorators with shared interface types are found ( #19361 )
...
Closes #19358
2017-09-25 11:59:21 -07:00
Peter Bacon Darwin
4c73b52d5c
docs(aio): tidy up tooling documentation ( #18151 )
...
PR Close #18151
2017-09-21 10:00:37 -07:00
Peter Bacon Darwin
4530654501
docs(aio): high-level documentation of the `transforms` folder ( #18151 )
...
PR Close #18151
2017-09-21 10:00:36 -07:00
Peter Bacon Darwin
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
Peter Bacon Darwin
988b9f8378
build(aio): remove commented out code ( #19265 )
...
PR Close #19265
2017-09-20 12:36:14 -07:00
Peter Bacon Darwin
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
Peter Bacon Darwin
a2b50ec8c9
build(aio): do not render annotations block for directives
2017-09-12 13:56:21 -04:00
Peter Bacon Darwin
77d24afea3
build(aio): improve rendering of directive selectors
2017-09-12 13:55:54 -04:00
Peter Bacon Darwin
39386eadea
build(aio): do not render comments in decorators
...
Closes #18873
2017-09-12 13:52:02 -04:00
Peter Bacon Darwin
bd928f3dcc
build(aio): render metadata members from decorator ancestors
2017-09-08 17:04:36 -04:00
Peter Bacon Darwin
e78402dd4c
build(aio): render ancestor members in directives
...
See `CheckBoxRequiredValidator` for an example.
2017-09-08 17:04:28 -04:00
Peter Bacon Darwin
917d0870e8
build(aio): don't show constructor detail if there is none
2017-09-08 13:21:16 -04:00
Pete Bacon Darwin
3c480e4e63
build(aio): support rendering of constructor overloads in API docs ( #19042 )
...
Closes #18258
2017-09-06 10:14:02 -07:00
Peter Bacon Darwin
35bc1eb218
build(aio): render the `extends` ancestors of classes in API docs ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
Peter Bacon Darwin
dc7de0896c
build(aio): ensure dgeni can load all angular Typescript modules ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
Zhicheng Wang
de34171fa2
Merge remote-tracking branch 'origin/master' into aio
...
# Conflicts:
# aio/content/guide/aot-compiler.md
# aio/content/guide/change-log.md
# aio/content/guide/ts-to-js.md
# aio/content/marketing/docs.md
# aio/content/navigation.json
# aio/src/app/documents/document.service.ts
2017-08-20 19:39:38 +08:00
Peter Bacon Darwin
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
Zhicheng Wang
a6df16f891
Merge branch 'master' into aio
...
# Conflicts:
# aio/content/guide/form-validation.md
# aio/content/guide/i18n.md
# aio/content/guide/reactive-forms.md
# aio/content/marketing/index.html
# aio/content/navigation.json
# aio/src/environments/environment.stable.ts
2017-08-08 13:10:17 +08:00
Zhicheng Wang
104edf62f0
fix: minor improvement
2017-08-06 13:49:04 +08:00
Zhicheng Wang
de6cfeeee3
clean: remove useless codes
2017-08-06 13:42:51 +08:00
Zhicheng Wang
0eaf9156de
fix: use new translation logic
2017-08-06 13:37:25 +08:00
Georgios Kalpakas
cc2a4c41f9
build(aio): fix warning about missing `<h1>`
...
Fixes #17549
2017-07-31 13:40:07 -07:00
Zhicheng Wang
f7b656443d
fix: limit tagName to whole world
2017-07-30 16:23:26 +08:00
Zhicheng Wang
3fe722490a
fix: don't hide translation-origin if there is not translation-result
...
fix: translate more.
2017-07-30 14:10:08 +08:00
Zhicheng Wang
747ea2a287
fix: retranslate navigation
2017-07-30 13:35:27 +08:00
Zhicheng Wang
c002fddabe
fix: many of broken links
2017-07-30 12:32:56 +08:00
Zhicheng Wang
f2059b445c
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/architecture.md
# aio/content/guide/attribute-directives.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/cb-index.md
# aio/content/guide/change-log.md
# aio/content/guide/cheatsheet.md
# aio/content/guide/cli-quickstart.md
# aio/content/guide/component-interaction.md
# aio/content/guide/component-styles.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/displaying-data.md
# aio/content/guide/dynamic-component-loader.md
# aio/content/guide/dynamic-form.md
# aio/content/guide/form-validation.md
# aio/content/guide/forms.md
# aio/content/guide/glossary.md
# aio/content/guide/hierarchical-dependency-injection.md
# aio/content/guide/i18n.md
# aio/content/guide/index.md
# aio/content/guide/learning-angular.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule.md
# aio/content/guide/npm-packages.md
# aio/content/guide/pipes.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/router.md
# aio/content/guide/security.md
# aio/content/guide/server-communication.md
# aio/content/guide/set-document-title.md
# aio/content/guide/setup-systemjs-anatomy.md
# aio/content/guide/setup.md
# aio/content/guide/structural-directives.md
# aio/content/guide/styleguide.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/guide/ts-to-js.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/upgrade.md
# aio/content/guide/user-input.md
# aio/content/guide/visual-studio-2015.md
# aio/content/guide/webpack.md
# aio/content/navigation.json
# aio/content/tutorial/index.md
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/package.json
# aio/src/styles/main.scss
# aio/transforms/angular.io-package/index.js
2017-07-30 00:09:50 +08:00
Georgios Kalpakas
d71ae278ef
fix(aio): fix links to source for paths with symlinks
...
Fixes #18353
2017-07-28 15:28:59 -07:00
WilliamKoza
36faba1aab
fix(aio): add quote to module
2017-07-18 17:48:04 +01:00
Peter Bacon Darwin
c453b7bcfa
build(aio): fail doc-gen if referenced images are missing
2017-07-18 11:45:05 +01:00
Peter Bacon Darwin
758848961e
build(aio): abort doc-gen on dangling links
2017-07-18 11:45:05 +01:00
Peter Bacon Darwin
99b666614d
build(aio): abort doc-gen if an example is missing
...
Closes #16936
2017-07-18 11:45:05 +01:00
Peter Bacon Darwin
0bf0c35bca
build(aio): render type parameters of API function exports
...
Fixes #18123
2017-07-15 08:52:35 +01:00
Alex Rickabaugh
db96c963a8
fix(aio): add <hr> in between overloads
2017-07-13 14:58:33 -07:00
Peter Bacon Darwin
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
Peter Bacon Darwin
a301dba68f
build(aio): improve API docs layout and styling
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
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
Peter Bacon Darwin
f06ce9adc8
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
be3352a084
build(aio): render grouped overloads
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
998049ec9b
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
e8bbf86e66
build(aio): add terms from heading to the search index
2017-07-11 15:04:37 +01:00
Peter Bacon Darwin
3a0886dc12
build(aio): capture all the headings from a doc in the vFile.headings property
2017-07-11 15:04:37 +01:00
Peter Bacon Darwin
d52ab8e2c9
build(aio): fix matchUpDirectiveDecorators processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
df7b875f6c
build(aio): fix mergeDecoratorDocs processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
470a7c6bcd
build(aio): use dedicated overview for decorator API docs
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
3abf208235
build(aio): update doc-gen templates
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
92c18d167e
build(aio): fix mergeDecoratorDocs processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
99b38f52cb
build(aio): fix matchUpDirectiveDecorators processor
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
633ec30291
build(aio): fix test description
2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
57cfcb0830
build(aio): refactor filterMemberDocs to be more general
...
Now it also filters function-overloads, hence the name change.
2017-07-11 11:44:05 +01:00
Suguru Inatomi
b3d90365b6
fix(aio): add new common/http package into API list
2017-07-10 12:23:47 +01:00
Victor Berchet
c723d42d0a
refactor: fix typos ( #18000 )
2017-07-07 16:55:17 -07:00
Peter Bacon Darwin
1d93cf2e85
build(aio): ensure all doc tests are run
...
It is not possible to run all the docs tests directly via the jasmine CLI.
Instead we now have a small script that will run jasmine via its library.
2017-06-21 13:51:15 -07:00
Peter Bacon Darwin
3fb98fe4ea
build(aio): do not recurse node_modules when loading examples in doc-gen
2017-06-21 13:51:15 -07:00
Peter Bacon Darwin
12452d4ab4
build(aio): increase docs integration test timeouts
...
The API docs tests have very variable run times, depending
upon the build environment.
This change doubles their test timeout values to prevent
false-negative failures.
2017-06-13 11:56:45 +01:00
George Kalpakas
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
Peter Bacon Darwin
3db6b6ca7a
build(aio): ignore example files that are gitignored
...
Rather than hard coding excludes into the dgeni config,
use the fact that we are already ignoring the boilerplate
and generated files via the .gitignore file.
2017-06-09 14:33:21 +01:00
Peter Bacon Darwin
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
Peter Bacon Darwin
cb2cb7c3bd
build(aio): display "call" and "new" members of interfaces in API docs
2017-05-31 08:45:50 +03:00
Peter Bacon Darwin
dfbbbb5e3e
build(aio): the the captured h1 as the title for the search index
...
If there is no title already provided, use the one captured from the renderedContent.
2017-05-31 08:45:31 +03:00
Peter Bacon Darwin
89f317915d
build(aio): use the captured h1 as the title if necessary
...
If the doc does not already have a `title` tag
then use the one captured from the renderedContent in
the final JSON output, instead.
2017-05-31 08:45:31 +03:00