48 Commits

Author SHA1 Message Date
Peter Bacon Darwin
8c7e2a1766 chore(dgeni-packages): update to use 0.15.2
This version includes the feature to hide members that
are marked private in TypeScript.
2016-09-09 14:41:36 -07:00
Igor Minar
08130d85df fix(api-builder): remove line number from the github source link
this info is not interesting to the reader.
2016-09-08 14:25:30 -07:00
Igor Minar
d83d3bd0a0 fix(api-builder): add a custom template for interface
before we were using the template for class which is wrong
2016-09-08 14:25:30 -07:00
Igor Minar
62d6a51436 fix(api-builder): remove bogus 'class export' section from class template 2016-09-08 14:25:30 -07:00
Eric Jimenez
cece720f47 output an audit file to keep track of documentation progress on API 2016-07-28 13:44:07 -07:00
Eric Jimenez
ca0acb6107 hide notes if none are found 2016-07-27 12:50:23 -04:00
Foxandxss
d1e6a24987 chore: add support for multiline annotations in the API 2016-07-04 17:03:20 +02:00
Peter Bacon Darwin
c4e87d9b83 api-builder: fix jade formatting of indented constructor code
Closes #1662
2016-06-13 22:42:56 -07:00
Eric Jimenez
1324085c0c feat(api docs): use partials for api docs. Implement deprecated and security notes section 2016-06-02 18:44:32 -07:00
Peter Bacon Darwin
0cb0bd7949 api-builder: fix class github link formatting 2016-05-19 19:16:24 -07:00
Peter Bacon Darwin
a42f3bf085 api-builder: fix githublinks
Closes #1435
Closes #1433
2016-05-19 19:16:24 -07:00
Eric Jimenez
621bc31c61 feat(no index): remove index from api list, it is unnecessary additional information from dgeni 2016-05-12 17:49:16 -07:00
Eric Jimenez
b5d2973163 feat(security badge): add a security badge to api docs. Only appears if @security is present in angular2 2016-05-12 17:48:54 -07:00
Eric Jimenez
d26461024c feat(dgeni audit): add more keys to the api-list, this makes it easier to see changes across the api 2016-05-11 19:46:23 -07:00
Naomi Black
acc5233671 chore(dgeni): update dgeni to handle repackaging changes 2016-05-02 13:00:06 -07:00
Eric Jimenez
1ac2a42308 chore(not yet documented): remove placeholder to reduce noise 2016-04-27 12:55:27 -04:00
Eric Jimenez
59c76790af docs(class, decorator, directive, function, var) improve doc styling 2016-04-25 16:58:03 -07:00
Eric Jimenez
8f158f2241 docs(sidenav reorg): remove glossary and cheatsheet from REFERENCE. Move glossary to BASICS. Rename REFERENCE to API REFERENCE 2016-04-25 14:10:57 -07:00
Eric Jimenez
9787a9ffb8 docs(static methods): fix style of static methods in api doc. anchoring works now 2016-04-22 17:13:05 -04:00
Eric Jimenez
baf84a48e8 docs(static methods): fix style of static methods in api doc. anchoring works now 2016-04-22 17:03:34 -04:00
Eric Jimenez
c932eec801 docs(code color fix): restored old color for code in parts that are not the api doc, use the same styling for all links in entire site 2016-04-21 12:03:12 -04:00
Eric Jimenez
3dd114d0df docs(class overview): list instance and static members with in-page hyperlinks. Also link constructor when present. Focus member on click. Badges look better in viewports of 600px or less 2016-04-20 13:14:18 -07:00
Eric Jimenez
c934fb704f docs(badges): add badges in hero to identify doc type to viewer, and stability. Stylize var.template for new api style docs. Add stable, experimental, docsNotRequired tagdef in dgeni 2016-04-19 20:49:48 -07:00
Eric Jimenez
5ea7738ad3 change class and directive template. 2016-04-16 03:17:47 -07:00
Eric Jimenez
fa4b597614 Add additional tags to the angular.io dgeni package for the new api doc style proposal.
Closes #1030
2016-04-01 17:37:21 +01:00
Peter Bacon Darwin
12e989da08 chore(doc-gen): include static members in the class template
Closes #761
2016-01-28 10:51:54 +00:00
Sebastian Müller
e20f191429 fix(directives): remove dashCase pipe 2016-01-22 18:49:03 -08:00
Peter Bacon Darwin
c94ad87dd4 chore(doc-gen): add createDecoratorDocs processor
The createDecoratorDocs processor identifies docs of exports that actually
represent decorators and get useful information for them.

This commit also set up the rest of the generation to display these new
decorator docs with their own template and updates the API list so that
we can filter the docs by decorator docType.
2016-01-10 21:16:47 -08:00
Peter Bacon Darwin
452e7e7729 chore(doc-gen): automatically update environment and version on the cheatsheet
Closes #515
2015-12-15 09:51:52 -08:00
Peter Bacon Darwin
05a272a116 refact(docs-app): move filtered API list into a directive
Each API index page now displays data from an `api-list.json` file found
locally to that page. This lets us have different API lists for TS, JS
and Dart.
2015-12-10 21:35:02 -08:00
Peter Bacon Darwin
326e1f7395 chore(doc-gen): upgrade to use TypeScript 1.7.3 2015-12-09 12:18:33 +00:00
Peter Bacon Darwin
3759d6e6db WIP: fix up path issues 2015-12-01 20:43:20 -08:00
Peter Bacon Darwin
7e3e77778d api-builder: fix indentation on "Not Yet Documented" message 2015-11-17 10:36:09 +00:00
Peter Bacon Darwin
bb170824ea api-builder: fix indentation on "Not Yet Documented" message 2015-11-17 10:05:03 +00:00
Naomi Black
c304aedb04 Revert "api-builder: add breadcrumbs links"
This reverts commit 10b87e80177791d0c852ddf07b4d89fc4893a6b1.
2015-11-16 23:10:18 -08:00
Peter Bacon Darwin
217c690781 api-builder: fix type-alias template so it doesn't break jade
The previous template was HTML rather than Jade and code blocks in the
content caused the Jade processing to crash.

See https://github.com/angular/angular/issues/4480
2015-11-15 21:36:20 +00:00
Peter Bacon Darwin
10b87e8017 api-builder: add breadcrumbs links 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin
888f9ff8d8 api-builder: move templates into angular.io package 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin
229557dcb2 api-builder: move the constructor into its own section 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin
ec4d7b82a2 api-builder: don't show constructor if it is marked as @internal 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin
f84534a9e2 api-builder: include exportAs info in directive docs 2015-11-13 16:39:20 +00:00
Peter Bacon Darwin
dbc95b75af api-builder: improve "not yet documented" handling
* All export members are now tagged if they have no documentation.
* All exports are tagged if they and their members have no documentation.
* The templates for these docs display the words "Not Yet Documented" if they are tagged.
* The build creates a warning for each export that is not documented
* The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which
lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:39:20 +00:00
Peter Bacon Darwin
489ffc9f97 api-builder: remove annotation block from directive docs 2015-11-13 16:38:58 +00:00
Peter Bacon Darwin
e86fde8dc9 chore(jade): upgrade to use marked filter
The `Transformers.markdown` (`:markdown`) filter is deprecated. This commit updates
the entire docs project to use the `jstransformer-marked` (`:marked') filter.
2015-11-10 18:37:53 +00:00
Peter Bacon Darwin
0f61ea288f api-builder: fix jade whitespace issues in the API templates 2015-11-10 18:37:20 +00:00
Peter Bacon Darwin
bc7a17c4f6 api-builder: remove unwanted whitespace from directive template 2015-11-10 11:37:06 +00:00
Peter Bacon Darwin
66a7edd8cb api-builder: add cheatsheet-package to generate cheatsheet data
Closes #348
2015-11-10 11:37:05 +00:00
Peter Bacon Darwin
83fbe75980 refact(api-builder): move into tools folder 2015-11-04 11:20:46 +00:00