graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2024-11-23 10:03:54 +03:00
Code Issues Packages Projects Releases Wiki Activity
91cc0ced86
graphene/docs
History
Syrus Akbary 1b39992dbe Merge branch 'refs/heads/master' into features/django-fields 
Conflicts:
	graphene/contrib/django/converter.py
	graphene/core/classtypes/enum.py
2016-04-02 20:06:44 -07:00
..
assets Improved travis deploy to build in a branch 2015-11-25 20:44:24 -08:00
css Added SQLAlchemy documentation and fixed installs 2016-01-23 14:40:08 -08:00
pages Merge branch 'refs/heads/master' into features/django-fields 2016-04-02 20:06:44 -07:00
playground Added starwars relay example 2015-11-30 02:31:17 -08:00
static Removed app cache. Added google analytics. 2015-11-30 02:15:55 -08:00
vendor First draft for docs 2015-11-25 11:23:31 -08:00
wrappers First version docs playground 2015-11-27 01:29:01 -08:00
.babelrc First draft for docs 2015-11-25 11:23:31 -08:00
.gitignore First draft for docs 2015-11-25 11:23:31 -08:00
app.js Removed app cache. Added google analytics. 2015-11-30 02:15:55 -08:00
config.toml Added Django Debug page 2016-02-04 14:13:24 -08:00
gatsby.config.js First fully working version of the playground editor 2015-11-27 23:50:20 -08:00
html.js Removed app cache. Added google analytics. 2015-11-30 02:15:55 -08:00
package.json Changed React-burger-menu version to be strict. Fixed #97 2016-01-31 15:16:50 -08:00
patched-react.js Added before install to travis for stopping build if only docs changed 2015-11-25 21:39:44 -08:00
README.md Updated READMEs 2015-11-30 00:25:18 -08:00

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.