Skip to content

Commit 2f38153

Browse files
Use typedoc to generate the api docs (#379)
1 parent 5704067 commit 2f38153

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+10883
-155
lines changed

.npmignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ examples
77
coverage/
88
.vscode/
99
docs/
10+
articles/
1011
yarn.lock
1112
circle.yml
1213
npm-debug.log
1314
.compiled
15+
ISSUE_TEMPLATE.md

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Features
44

55
* Added `NgReduxTestingModule`, `MockNgRedux` to help unit test components and
6-
services that select from the store. See [here](docs/intro-tutorial.md#unit-testing-selections)
6+
services that select from the store. See [here](articles/intro-tutorial.md#unit-testing-selections)
77
for details.
88
* Expose `PathSelector`, `FunctionSelector`, and `PropertySelector` types in `index.d.ts`.
99

@@ -323,8 +323,8 @@ export class MyComponent {
323323

324324
### Features
325325

326-
* [DevToolsExtension - convience wrapper for dev tools](docs/redux-dev-tools.md) (#115)
327-
* [Select - seamless support for ImmutableJS](docs/immutable-js.md) (#160)
326+
* [DevToolsExtension - convience wrapper for dev tools](articles/redux-dev-tools.md) (#115)
327+
* [Select - seamless support for ImmutableJS](articles/immutable-js.md) (#160)
328328

329329

330330
### Fixes

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ with some of Angular's advanced features, including:
3131

3232
## Getting Started
3333

34-
* I already know what Redux and RxJS are. [Give me the TL;DR](docs/quickstart.md).
35-
* I'm just learning about Redux. [Break it down for me](docs/intro-tutorial.md)!
34+
* I already know what Redux and RxJS are. [Give me the TL;DR](articles/quickstart.md).
35+
* I'm just learning about Redux. [Break it down for me](articles/intro-tutorial.md)!
3636
* Talk is cheap. [Show me a complete code example](https://github.com/angular-redux/example-app).
37-
* Take me to the [API docs](docs/api.md).
37+
* Take me to the [API docs](angular-redux.github.io/store).
3838

3939
## Examples
4040

@@ -60,13 +60,13 @@ Here are some examples of the `angular-redux` family of packages in action:
6060
data on its way out of the store and into your UI or side-effect handlers. Observables
6161
are an efficient analogue to `reselect` for the RxJS-heavy Angular world.
6262

63-
Read more here: [Select Pattern](docs/select-pattern.md)
63+
Read more here: [Select Pattern](articles/select-pattern.md)
6464

6565
We also have a number of 'cookbooks' for specific Angular topics:
6666

67-
* [Using Angular's Dependency Injector with Action Creators](docs/action-creator-service.md)
68-
* [Using Angular's Dependency Injector with Middlewares](docs/di-middleware.md)
69-
* [Managing Side-Effects with redux-observable Epics](docs/epics.md)
70-
* [Using the Redux DevTools Chrome Extension](docs/redux-dev-tools.md)
71-
* [@angular-redux/store and ImmutableJS](docs/immutable-js.md)
72-
* [Strongly Typed Reducers](docs/strongly-typed-reducers.md)
67+
* [Using Angular's Dependency Injector with Action Creators](articles/action-creator-service.md)
68+
* [Using Angular's Dependency Injector with Middlewares](articles/di-middleware.md)
69+
* [Managing Side-Effects with redux-observable Epics](articles/epics.md)
70+
* [Using the Redux DevTools Chrome Extension](articles/redux-dev-tools.md)
71+
* [@angular-redux/store and ImmutableJS](articles/immutable-js.md)
72+
* [Strongly Typed Reducers](articles/strongly-typed-reducers.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/intro-tutorial.md renamed to articles/intro-tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ number update accordingly.
372372

373373
This is the essence of using `NgRedux`. However, one of the benefits of using Observables with Angular
374374
is that Angular has first-class, optimized support for rendering them via a construct called
375-
[async pipe](https://angular.io/docs/ts/latest/api/common/index/AsyncPipe-pipe.html).
375+
[async pipe](https://angular.io/articles/ts/latest/api/common/index/AsyncPipe-pipe.html).
376376

377377
Instead of manually subscribing to our selected observable, and then remembering to unsubscribe,
378378
we can use `| async` in our template. This causes Angular to manage the subscription, and also allows
@@ -472,7 +472,7 @@ class MyComponent {
472472
```
473473

474474
> There's actually quite a lot more you can do with `@select` and `ngRedux.select`. Check out the
475-
> [API docs](https://github.com/angular-redux/store/blob/master/docs/api.md#selectkey--path--function) for more info.
475+
> [API docs](angular-redux.github.io/store/classes/ngredux.html#select) for more info.
476476
477477
## Unit Testing Selections
478478

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/api.md

Lines changed: 0 additions & 106 deletions
This file was deleted.

0 commit comments

Comments
 (0)