Skip to content

Commit

Permalink
adjust config and fix jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
James Baxley committed Oct 17, 2017
1 parent 8540da5 commit 3b03f6c
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 57 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
[submodule "code"]
path = code
url = https://github.com/apollographql/apollo-client.git
[submodule "docs/themes/meteor"]
path = docs/themes/meteor
url = https://github.com/meteor/hexo-theme-meteor.git
13 changes: 6 additions & 7 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,15 @@ sidebar_categories:
- polymer
- ember

# not sure if we should rename this?
github_repo: apollostack/docs
github_repo: apollographql/apollo-client
content_root: source

typescript_api_box:
data_file: docs.json

social_links:
github: 'https://github.com/apollostack'
twitter: '@apollostack'
github: 'https://github.com/apollographql'
twitter: '@apollographql'

# API keys
apis:
Expand All @@ -46,14 +45,14 @@ apis:

# URL
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
url: http://dev.apollodata.com/core
root: /core/
url: https://www.apollographql.com/docs/core
root: /docs/core/
permalink: :year/:month/:day/:title/
permalink_defaults:

# Directory
source_dir: source
public_dir: public
public_dir: public/docs/core
tag_dir: tags
archive_dir: archives
category_dir: categories
Expand Down
8 changes: 3 additions & 5 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"hexo": {
"version": "3.2.2"
"version": "3.3.8"
},
"dependencies": {
"hexo": "3.3.8",
Expand All @@ -22,12 +22,10 @@
"hexo-s3-deploy": "^1.2.1"
},
"scripts": {
"postinstall":
"cd code && npm install && npm uninstall typescript && npm install typescript@2.1.6",
"build": "cd code; typedoc --json ../docs.json --ignoreCompilerErrors",
"build":
"cd ../packages/apollo-client; typedoc --json ../../docs/docs.json --ignoreCompilerErrors",
"prestart": "npm run build",
"start": "hexo serve",
"predeploy": "npm run build",
"deploy": "hexo-s3-deploy"
}
}
45 changes: 0 additions & 45 deletions docs/source/apollo-client-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,10 @@ The `ApolloClient` class is the core API for Apollo, and the one you'll need to
{% tsapibox ApolloClient.readFragment %}
{% tsapibox ApolloClient.writeQuery %}
{% tsapibox ApolloClient.writeFragment %}
{% tsapibox ApolloClient.reducer %}
{% tsapibox ApolloClient.dataId %}
{% tsapibox ApolloClient.dataIdFromObject %}
{% tsapibox ApolloClient.middleware %}
{% tsapibox ApolloClient.initStore %}
{% tsapibox ApolloClient.setStore %}
{% tsapibox ApolloClient.resetStore %}

<h2 id="ObservableQuery">ObservableQuery</h2>

{% tsapibox ObservableQuery.subscribe %}
{% tsapibox ObservableQuery.variables %}
{% tsapibox ObservableQuery.result %}
{% tsapibox ObservableQuery.currentResult %}
Expand All @@ -46,41 +39,3 @@ The `ApolloClient` class is the core API for Apollo, and the one you'll need to
{% tsapibox ApolloError.networkError %}
{% tsapibox ApolloError.extraInfo %}

<h2 id="DataProxy">DataProxy</h2>

An interface to the normalized data in your store. `ApolloClient` implements this interface and so do various other objects you may receive when updating the store. A `DataProxy` is used in the `update` function on `client.mutate` to give you a window into your normalized data.

This interface is currently only used in the context of the `update` function provided to [`ApolloClient.mutate`](apollo-client-api.html#ApolloClient.mutate).

{% tsapibox DataProxy.readQuery %}
{% tsapibox DataProxy.readFragment %}
{% tsapibox DataProxy.writeQuery %}
{% tsapibox DataProxy.writeFragment %}

<h2 id="utilities">Utilities</h2>

{% tsapibox createNetworkInterface %}
<!-- XXX: fix aliasing-->
{% tsapibox addTypenameToSelectionSet %}

<h2 id="types">Types</h2>

{% tsapibox ApolloQueryResult %}
{% tsapibox ApolloCurrentResult %}
{% tsapibox ApolloStore %}
{% tsapibox NetworkStatus %}
{% tsapibox NetworkInterface %}
{% tsapibox NetworkInterfaceOptions %}
{% tsapibox HTTPNetworkInterface %}
{% tsapibox BatchedNetworkInterface %}
{% tsapibox NormalizedCache %}
{% tsapibox ApolloReducerConfig %}
{% tsapibox MutationBehaviorReducerArgs %}
{% tsapibox MutationArrayInsertBehavior %}
{% tsapibox MutationArrayDeleteBehavior %}
{% tsapibox MutationDeleteBehavior %}
{% tsapibox Request %}
{% tsapibox StoreObject %}
{% tsapibox FragmentMap %}
{% tsapibox Observer %}
{% tsapibox Subscription %}
1 change: 1 addition & 0 deletions docs/themes/meteor
Submodule meteor added at 7aa2df

0 comments on commit 3b03f6c

Please sign in to comment.