graphene/docs/README.md

Graphene Docs

Graphene docs are powered by gatsby.

Installation

For running locally this docs. You have to execute

npm install -g gatsby && npm install

And then

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 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:

npm run build

Automation

Thanks to Travis, 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 have always the latest docs.