mirror of
https://github.com/graphql-python/graphene.git
synced 2025-02-02 12:44:15 +03:00
Updated READMEs
This commit is contained in:
parent
e407993e1f
commit
5a953e9a57
|
@ -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 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.
|
- **Easy to use:** Graphene helps you use GraphQL in Python without effort.
|
||||||
- **Relay:** Graphene has builtin support for Relay
|
- **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.
|
*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
|
## Installation
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
|Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
|
|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
|
`Graphene <http://graphene-python.org>`__ is a Python library for
|
||||||
easily.
|
building GraphQL schemas/types fast and easily.
|
||||||
|
|
||||||
- **Easy to use:** Graphene helps you use GraphQL in Python without
|
- **Easy to use:** Graphene helps you use GraphQL in Python without
|
||||||
effort.
|
effort.
|
||||||
|
@ -16,6 +16,9 @@ easily.
|
||||||
ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition
|
ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition
|
||||||
to queries, mutations and subscriptions.
|
to queries, mutations and subscriptions.
|
||||||
|
|
||||||
|
**NEW**!: `Try graphene
|
||||||
|
online <http://graphene-python.org/playground/>`__
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
# Graphene Docs
|
# Graphene Docs
|
||||||
Docs for Graphene
|
|
||||||
|
Graphene docs are powered by [gatsby](https://github.com/gatsbyjs/gatsby).
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -14,3 +15,29 @@ And then
|
||||||
```bash
|
```bash
|
||||||
gatsby develop
|
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.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user