Peter Bacon Darwin
26320160f9
api-templates: only show directive inputs/outputs if there are some
2015-11-03 23:39:11 +00:00
Peter Bacon Darwin
b5744c813a
api-index: generate index page API list dynamically
...
Dgeni now generates a JSON file that is loaded by the AppController into
the index page for the API docs.
2015-11-03 16:41:38 +00:00
Peter Bacon Darwin
62adb91544
api-templates: separate out selectors into a list
2015-11-03 14:43:51 +00:00
Peter Bacon Darwin
e0f5261d3b
api-templates: extract and render directive info distinct from classes
...
Closes #221
2015-11-03 14:18:49 +00:00
Peter Bacon Darwin
b176f42302
api-templates: display name and type of class-ish docs at top of content
2015-11-03 12:33:35 +00:00
Peter Bacon Darwin
0292deece1
api-templates: display members as simple formatted code
...
See https://github.com/angular/angular/issues/4258
2015-11-03 12:33:34 +00:00
Peter Bacon Darwin
3fedcc9525
api-templates: don't show annotations block in classes if there is an empty list
...
Previously the block would be hidden only if the annotations property was
falsy, now it is also hidden if the property is also an empty array
2015-11-03 12:33:34 +00:00
Peter Bacon Darwin
ca5553e4eb
api-templates: include type in heading of var-type docs
2015-11-03 12:33:34 +00:00
Peter Bacon Darwin
d404a7d2cf
docs-package: don't initialize the `readFilesProcessor`
...
The current setup for angular.io does not use the `readFilesProcessor`
so the `docs-package` doesn't need to configure it.
(For example, all the guide docs are written in straight Jade and are not
processed by dgeni).
In fact the `angular.io-package` explicitly disables this processor.
Given this, setting the basePath for the `readFilesProcessor` in the
`angular.io-package` is not really a hack, since we do need it for the
`writeFilesProcessor`.
2015-11-03 12:33:34 +00:00
Simon Kuang
d9b51cea0c
fix spelling errors under case sensitive environment like linux
2015-10-31 21:47:43 -07:00
Peter Bacon Darwin
d270920fe4
chore(package.json): update to dgeni-packages 0.11.0
...
This version includes the start-end inline tags that will help use to be able
to target blocks of text to different sets of documentation.
2015-10-31 20:51:32 +00:00
Naomi Black
7348381c5f
docs(API): change style on not documented template
2015-10-18 12:07:49 +01:00
Jay Traband
6393774355
Track and warn about "Not yet documented" pages and also add "Not Yet Documented" to the top of these pages.
2015-10-18 12:07:49 +01:00
Peter Bacon Darwin
3baf6c0561
refactor(checkUnbalancedTicks): split out convertBackticksToCodeBlocks to maintain cohesion
...
This improves upon changes made in 28a805733f6bd8b3a3394ea29c828c17b391c855
as part of #277
2015-10-17 19:11:53 -07:00
Peter Bacon Darwin
23452bffa0
chore(doc-gen): filter unwanted decorators from angular.io docs
...
Closes https://github.com/angular/angular/issues/3705
2015-10-17 16:46:19 +01:00
Jay Traband
09597710c7
fix for issue with check-deploy failing
2015-10-16 18:17:36 -07:00
Jay Traband
61c6b7d5af
additional comments
2015-10-16 18:17:36 -07:00
Jay Traband
5d3471b8e1
Fix for issue with {{ }} sections inside of fenced backtics.
2015-10-16 18:17:35 -07:00
Robert Messerle
f38e6e7bd4
cleans up various alignment and layout issues
2015-10-09 16:27:33 -07:00
Alex Eagle
97ae3d0ca9
chore(docs): rename @private to @internal
...
This change corresponds to https://github.com/angular/angular/pull/4477
2015-10-05 03:28:42 -07:00
Peter Bacon Darwin
9f5b6d2353
fix(doc-gen): ignore resolved symbols that have no declarations
2015-10-02 12:35:01 +01:00
Jay Traband
6f6e83722e
squashed commits for PR 222 from jtraband
...
- add warning when bad example tag is encountered.
- shredding for api docs + refactoring of gulpfile to clarify task names.
- added top level gulp tasks + error handling cleanup
- added test-api-builder gulp task
- added warning messages during build-shred-map processing
- mixin signature change
- updated styleguide ... continued.
- added @exampleTabs inlinetag support + refactoring shared services between @example and @exampleTabs
- added new inline tag @linkDevGuide + cleanup
- added angular source watch logic for serve-and-sync and source for examples changed from test -> examples + cleanup
- promisify del
- styleguide explanation of @example, @exampleTabs and @linkDevGuide
2015-09-23 14:04:58 -07:00
Jay Traband
49496e4ce9
fix(indentForMarkdown) extra trailing spaces on last line.
2015-09-18 15:35:12 -07:00
Jay Traband
26a1405e40
refact(links-package): clean up example tag
2015-09-18 13:27:38 -07:00
Peter Bacon Darwin
39f1959f2e
refact(angular.io-package): compute the correct path rather than fixing up later
2015-09-18 13:27:37 -07:00
Peter Bacon Darwin
166d932ee4
refact(angular.io-package): remove unnecessary public-docs-package
2015-09-18 13:27:36 -07:00
Peter Bacon Darwin
6e643c9622
feat(angular.io-package): render the originalModule field in the jade-data docs
2015-09-18 13:27:36 -07:00
Peter Bacon Darwin
4813e9e172
feat(typescipt-package): capture the original module name for re-exports
...
This change adds the original module name, for items that have been re-exported
to the current module, as the `originalModule` property on the `exportDoc`.
2015-09-18 13:27:35 -07:00
Peter Bacon Darwin
a6b88063f2
feat(angular.io-package): add docType info into jade-data docs
2015-09-18 13:27:34 -07:00
Peter Bacon Darwin
fd26ee8fbe
feat(angular.io-package): sort exports alphabetically
2015-09-18 13:27:32 -07:00
Jay Traband
0698bd95b3
merge fix
2015-09-18 13:25:18 -07:00
Peter Bacon Darwin
f9ad58eba5
chore(angular.io-package): fix blank line trimming for Jade docs
...
Jade does not like to have lines with only whitespace between processing marks
and the start of the actual content.
This fix provides a nunjucks filter that can strip off such offending whitespace
when rendering into a Jade syntax file.
2015-09-18 13:22:45 -07:00
Jay Traband
4dcf2210d7
updated version of example inline tag def
2015-09-18 13:22:43 -07:00
Jay Traband
e3d525cf2a
added path to _utilFns to all api templates so that mixins become avail
2015-09-18 13:22:41 -07:00
Jay Traband
f6b89d6202
refactoring
2015-09-18 13:22:39 -07:00
Jay Traband
9922372447
introducing 'example' inline tag
2015-09-18 13:22:37 -07:00
Jay Traband
44d066f14c
cleanup
2015-09-18 13:22:33 -07:00
Jay Traband
834b65dca3
cleanup/comment api builder
2015-09-18 13:22:32 -07:00
Jay Traband
3d997d2994
Initial pass at moving api doc builder over to angular.io
2015-09-18 13:18:53 -07:00