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
Peter Bacon Darwin
92ca0f3a9f
api-builder: add project specific typescript configuration
2016-05-12 03:40:57 -07:00
Peter Bacon Darwin
ac583748d1
api-builder: update to dgeni-packages 0.12.0 - factoring out the typescript package
2016-05-12 03:40:57 -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
8a29e502d3
chore(api): hide another private function
2016-05-03 18:48:09 -07:00
Naomi Black
d442b30a68
chore(dgeni): update dgeni to serve old and new router
2016-05-02 17:42:05 -07:00
Naomi Black
acc5233671
chore(dgeni): update dgeni to handle repackaging changes
2016-05-02 13:00:06 -07:00
Naomi Black
b89647add4
chore(dgeni): fix missing apis in the master list
2016-04-29 17:20:59 -07:00
Naomi Black
e91b4254de
docs(dgeni): fix Location-class missing from API list
2016-04-28 19:21:26 -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
Peter Bacon Darwin
d6d46076b7
fix(api-builder): add missing git package dependency
...
This was causing the api-builder tests to fail
2016-04-01 21:26:03 +01: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
Naomi Black
9e43a4f425
dgeni(upgrade): add upgrade which was missing from api docs
2016-02-10 15:04:09 -08: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
Naomi Black
f7b6d83422
docs(dgeni): add in missing barrel files
...
closes #465
2015-12-09 14:49:35 -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
46735ad925
chore(doc-gen): fix target-package tests
2015-12-09 11:51:52 +00:00
Peter Bacon Darwin
3ede7bfea9
chore(doc-gen): new syntax for cheatsheet items
2015-12-08 17:37:19 -08:00
Peter Bacon Darwin
8459a4dd5c
chore(doc-gen): allow dart cheatsheet to be generated
2015-12-08 17:31:53 -08:00
Peter Bacon Darwin
af105bb354
chore(doc-gen): remove unwanted console.log
2015-12-02 11:53:50 +00:00
Peter Bacon Darwin
3759d6e6db
WIP: fix up path issues
2015-12-01 20:43:20 -08:00
Peter Bacon Darwin
eb37614d68
chore(doc-gen): update modules to include API docs
...
The public exported modules have been reorganized
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 10b87e8017
.
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
244e5673ab
api-builder: filter out member docs
...
Since we are not rendering these independently of their containers
2015-11-13 16:39:21 +00:00
Peter Bacon Darwin
954a3827b7
api-builder: add simplified name to module docs
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
a98085e7eb
api-builder: allow descriptions to be empty via the `@noDescription` tag
...
If a document description is empty then it is marked with the `notYetDocumented`
property. This change allows developers to tag a code item (export, member, etc)
as explicitly not needing a description.
2015-11-13 16:39:21 +00:00
Peter Bacon Darwin
21feaf499f
api-builder: deduce the type of a symbol from its initializer
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
7239b52984
api-builder: remove unnecessary outputFolder config setting from angular.io-package
...
This is set in the gulpfile now
2015-11-13 16:38:58 +00:00
Peter Bacon Darwin
ed3a4965e5
api-building: add `@syntax` tag to docs-package
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
fc617d5a67
api-builder: fix incorrect jasmine matcher in target package tests
2015-11-10 11:37:06 +00:00
Peter Bacon Darwin
93c187de2a
api-builder: trim blank lines from the end of a text block too
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
b68ef96472
api-builder: add target package
2015-11-07 09:30:55 +00:00
Peter Bacon Darwin
bc8a319f61
api-builder: move ngdoc stuff out from doc-package and into content package
2015-11-06 12:51:25 +00:00
Peter Bacon Darwin
d08ebf4b9a
api-builder: refactor app-data doc to use generic pathTemplates
2015-11-04 16:21:11 +00:00
Peter Bacon Darwin
bdc647462e
angular.io-package: fix up test to match new functionality
2015-11-04 11:20:47 +00:00
Peter Bacon Darwin
83fbe75980
refact(api-builder): move into `tools` folder
2015-11-04 11:20:46 +00:00