Merge pull request #53 from graphql-python/docs

Docs. Fixed #19

Author: syrusakbary

.gitignore

@@ -61,3 +61,14 @@ target/
 
 
 /tests/django.sqlite
+
+/graphene/index.json
+/graphene/meta.json
+
+/meta.json
+/index.json
+
+/docs/playground/graphene-js/pypyjs-release-nojit/
+/docs/static/playground/lib
+
+/docs/static/playground

.travis.yml

@@ -6,13 +6,79 @@ python:
 - 3.4
 - 3.5
 - pypy
-cache: pip
+cache:
+  directories:
+  - .cache/pip/
+  - $HOME/.cache/pip
+  - docs/node_modules/
+  - $HOME/docs/node_modules
+before_install:
+- |
+  if [ "$TEST_TYPE" != build_website ] && \
+    ! git diff --name-only $TRAVIS_COMMIT_RANGE | grep -qvE '(\.md$)|(^(docs))/'
+  then
+    echo "Only docs were updated, stopping build process."
+    exit
+  fi
 install:
-- pip install --cache-dir $HOME/.cache/pip pytest pytest-cov coveralls flake8 six blinker pytest-django
-- pip install --cache-dir $HOME/.cache/pip -e .[django]
-- python setup.py develop
+- |
+  if [ "$TEST_TYPE" = build ]; then
+    pip install --download-cache $HOME/.cache/pip/ pytest pytest-cov coveralls six pytest-django
+    pip install --download-cache $HOME/.cache/pip/ -e .[django]
+    python setup.py develop
+  elif [ "$TEST_TYPE" = build_website ]; then
+    pip install --download-cache $HOME/.cache/pip/ -e .
+    python setup.py develop
+  elif [ "$TEST_TYPE" = lint ]; then
+    pip install --download-cache $HOME/.cache/pip/ flake8
+  fi
 script:
-- py.test --cov=graphene
-- flake8
+- |
+  if [ "$TEST_TYPE" = build_website ]; then
+    if [ "$TRAVIS_BRANCH" = "master" ] && [ "$TRAVIS_PULL_REQUEST" = false ]; then
+      echo "Building the web."
+      nvm install 4.0
+
+      GH_PAGES_DIR="$TRAVIS_BUILD_DIR"/docs/public
+      git config --global user.name "Travis CI"
+      git config --global user.email "[email protected]"
+      git clone --branch gh-pages --depth=50 \
+        https://[email protected]/graphql-python/graphene.git \
+        $GH_PAGES_DIR
+      cd docs
+      ./playground/graphene-js/build.sh
+      npm run deploy
+      cd $GH_PAGES_DIR
+      git status
+      git add --intent-to-add .
+      if ! git diff-index --quiet HEAD --; then
+        git add -A .
+        git commit -m "Rebuild website"
+        git push "https://${GITHUB_TOKEN}@github.com/graphql-python/graphene.git" gh-pages
+      fi
+      exit
+    fi
+  elif [ "$TEST_TYPE" = lint ]; then
+    echo "Checking Python code lint."
+    flake8
+    exit
+  elif [ "$TEST_TYPE" = build ]; then
+    py.test --cov=graphene
+  fi
 after_success:
-- coveralls
+- |
+  if [ "$TEST_TYPE" = build ]; then
+      coveralls
+  fi
+env:
+  matrix:
+  - TEST_TYPE=build
+  global:
+    secure: SQC0eCWCWw8bZxbLE8vQn+UjJOp3Z1m779s9SMK3lCLwJxro/VCLBZ7hj4xsrq1MtcFO2U2Kqf068symw4Hr/0amYI3HFTCFiwXAC3PAKXeURca03eNO2heku+FtnQcOjBanExTsIBQRLDXMOaUkf3MIztpLJ4LHqMfUupKmw9YSB0v40jDbSN8khBnndFykmOnVVHznFp8USoN5F0CiPpnfEvHnJkaX76lNf7Kc9XNShBTTtJsnsHMhuYQeInt0vg9HSjoIYC38Tv2hmMj1myNdzyrHF+LgRjI6ceGi50ApAnGepXC/DNRhXROfECKez+LON/ZSqBGdJhUILqC8A4WmWmIjNcwitVFp3JGBqO7LULS0BI96EtSLe8rD1rkkdTbjivajkbykM1Q0Tnmg1adzGwLxRUbTq9tJQlTTkHBCuXIkpKb1mAtb/TY7A6BqfnPi2xTc/++qEawUG7ePhscdTj0IBrUfZsUNUYZqD8E8XbSWKIuS3SHE+cZ+s/kdAsm4q+FFAlpZKOYGxIkwvgyfu4/Plfol4b7X6iAP9J3r1Kv0DgBVFst5CXEwzZs19/g0CgokQbCXf1N+xeNnUELl6/fImaR3RKP22EaABoil4z8vzl4EqxqVoH1nfhE+WlpryXsuSaF/1R+WklR7aQ1FwoCk8V8HxM2zrj4tI8k=
+matrix:
+  fast_finish: true
+  include:
+  - python: '2.7'
+    env: TEST_TYPE=build_website
+  - python: '2.7'
+    env: TEST_TYPE=lint

README.md

@@ -1,7 +1,7 @@
 # ![Graphene Logo](http://graphene-python.org/favicon.png) [Graphene](http://graphene-python.org) [![Build Status](https://travis-ci.org/graphql-python/graphene.svg?branch=master)](https://travis-ci.org/graphql-python/graphene) [![PyPI version](https://badge.fury.io/py/graphene.svg)](https://badge.fury.io/py/graphene) [![Coverage Status](https://coveralls.io/repos/graphql-python/graphene/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-python/graphene?branch=master)
 
 
-Graphene is a Python library for building GraphQL schemas/types fast and easily.
+[Graphene](http://graphene-python.org) is a Python library for building GraphQL schemas/types fast and easily.
 
 - **Easy to use:** Graphene helps you use GraphQL in Python without effort.
 - **Relay:** Graphene has builtin support for Relay
@@ -10,6 +10,7 @@ Graphene is a Python library for building GraphQL schemas/types fast and easily.
 
 *What is supported in this Python version?* **Everything**: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions.
 
+**NEW**!: [Try graphene online](http://graphene-python.org/playground/)
 
 ## Installation
 

README.rst

@@ -1,8 +1,8 @@
 |Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
 =========================================================================================================
 
-Graphene is a Python library for building GraphQL schemas/types fast and
-easily.
+`Graphene <http://graphene-python.org>`__ is a Python library for
+building GraphQL schemas/types fast and easily.
 
 -  **Easy to use:** Graphene helps you use GraphQL in Python without
    effort.
@@ -16,6 +16,9 @@ easily.
 ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition
 to queries, mutations and subscriptions.
 
+**NEW**!: `Try graphene
+online <http://graphene-python.org/playground/>`__
+
 Installation
 ------------
 

docs/.babelrc

@@ -0,0 +1,3 @@
+{
+  "stage": 0
+}

docs/.gitignore

@@ -0,0 +1,29 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+
+public/

docs/README.md

@@ -0,0 +1,43 @@
+# Graphene Docs
+
+Graphene docs are powered by [gatsby](https://github.com/gatsbyjs/gatsby).
+
+
+## Installation
+
+For running locally this docs. You have to execute
+```bash
+npm install -g gatsby && npm install
+```
+
+And then
+
+```bash
+gatsby develop
+```
+
+## Playground
+
+If you want to have the playground running too, just execute
+
+```
+./playground/graphene-js/build.sh
+```
+
+This command will clone the [pypyjs-release-nojit](https://github.com/pypyjs/pypyjs-release-nojit) repo, update it with the latest graphene, graphql-core and graphql-relay code, and make it available for the `/playground` view in the docs.
+
+
+## Build
+
+For building the docs into the `public` dir, just run:
+
+```bash
+npm run build
+```
+
+
+## Automation
+
+Thanks to [Travis](https://github.com/graphql-python/graphene/blob/master/.travis.yml#L39-L58), we automated the way documentation is updated in the `gh-pages` branch.
+
+Each time we modify the docs in the `master` branch the travis job runs and updates the `gh-pages` branch with the latest code, so [Graphene's website](http://graphene-python.org) have always the latest docs.

docs/app.js

@@ -0,0 +1,19 @@
+exports.loadContext = function(callback) {
+  var context;
+  context = require.context('./pages', true);
+  if (module.hot) {
+    module.hot.accept(context.id, function() {
+      context = require.context('./pages', true);
+      return callback(context);
+    });
+  }
+  return callback(context);
+};
+
+exports.onRouteChange = function(state) {
+  if (typeof window !== "undefined" && window.ga) {
+    window.ga('send', 'pageview', {
+      page: state.pathname
+    });
+  }
+}

docs/assets/icon.js

@@ -0,0 +1,7 @@
+import React from 'react';
+
+export default class Icon extends React.Component {
+    render() {
+        return <span {...this.props} src={null} dangerouslySetInnerHTML={{__html:this.props.src}} />
+    }
+}