graphene/docs/index.rst

Graphene
========

------------

The documentation below is for the ``dev`` (prerelease) version of Graphene. To view the documentation for the latest stable Graphene version go to the `v2 docs <https://docs.graphene-python.org/en/stable/>`_.

------------

Contents:

.. toctree::
   :maxdepth: 2

   quickstart
   types/index
   execution/index
   relay/index
   testing/index
   api/index

.. _Integrations:

Integrations
------------

* `Graphene-Django <http://docs.graphene-python.org/projects/django/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-django/>`_)
* Flask-Graphql (`source <https://github.com/graphql-python/flask-graphql>`_)
* `Graphene-SQLAlchemy <http://docs.graphene-python.org/projects/sqlalchemy/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-sqlalchemy/>`_)
* `Graphene-GAE <http://docs.graphene-python.org/projects/gae/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-gae/>`_)
* `Graphene-Mongo <http://graphene-mongo.readthedocs.io/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-mongo>`_)
* `Starlette <https://www.starlette.io/graphql/>`_ (`source <https://github.com/encode/starlette>`_)
* `FastAPI <https://fastapi.tiangolo.com/advanced/graphql/>`_ (`source <https://github.com/tiangolo/fastapi>`_)
First version of integrated Graphene sphinx docs ✨ 2016-09-12 07:47:34 +03:00			`Graphene`
			`========`

Update readme (#1130) * Add slack link and dev notice to the README * Fix formatting * Update formatting * Add notice to documentation 2020-01-30 19:17:12 +03:00			`------------`

			The documentation below is for the ``dev`` (prerelease) version of Graphene. To view the documentation for the latest stable Graphene version go to the `v2 docs <https://docs.graphene-python.org/en/stable/>`_.

			`------------`

First version of integrated Graphene sphinx docs ✨ 2016-09-12 07:47:34 +03:00			`Contents:`

			`.. toctree::`
			`:maxdepth: 2`

			`quickstart`
			`types/index`
Added middleware docs 2016-10-31 07:32:00 +03:00			`execution/index`
First version of integrated Graphene sphinx docs ✨ 2016-09-12 07:47:34 +03:00			`relay/index`
Added testing docs 2017-04-10 10:47:20 +03:00			`testing/index`
expose livehtml autobuild in Makefile + Add API autodoc (#971) * expose livehtml autobuild in Makefile * add API documentation for schema * document graphene core API * fixes black lint * Update graphene/types/union.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/argument.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/field.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/inputfield.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * add note about non-functional `interfaces` meta argument in mutation * update with other virtual environment configuration * pin autobuild * format argument example code * format enum input object and interface examples * format enum mutation union examples * revise documentation with imports, capitalization 2019-06-10 01:36:06 +03:00			`api/index`
Added inter docs 2016-09-21 10:51:57 +03:00
Revise documentation (#969) * Revise documentation - Add missing reference to `flask-graphql` in integrations - align documentation for resolver arguments (use root for 1st argument instead of self) - explore use of `parent` instead of `root` for first argument - clarify resolvers and object type documentation - add documentation for Meta class options for ObjectType - expand quickstart documentation for first time users - streamline order of documentation for first time users (broad -> specific) - document resolver quirks * explict imports from graphene * rename doc refs for resolvers * suggestions typos and graphene import 2019-06-10 02:49:56 +03:00			`.. _Integrations:`

Added inter docs 2016-09-21 10:51:57 +03:00			`Integrations`
expose livehtml autobuild in Makefile + Add API autodoc (#971) * expose livehtml autobuild in Makefile * add API documentation for schema * document graphene core API * fixes black lint * Update graphene/types/union.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/argument.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/field.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * Update graphene/types/inputfield.py Co-Authored-By: Jonathan Kim <jkimbo@gmail.com> * add note about non-functional `interfaces` meta argument in mutation * update with other virtual environment configuration * pin autobuild * format argument example code * format enum input object and interface examples * format enum mutation union examples * revise documentation with imports, capitalization 2019-06-10 01:36:06 +03:00			`------------`
Added inter docs 2016-09-21 10:51:57 +03:00
			* `Graphene-Django <http://docs.graphene-python.org/projects/django/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-django/>`_)
Revise documentation (#969) * Revise documentation - Add missing reference to `flask-graphql` in integrations - align documentation for resolver arguments (use root for 1st argument instead of self) - explore use of `parent` instead of `root` for first argument - clarify resolvers and object type documentation - add documentation for Meta class options for ObjectType - expand quickstart documentation for first time users - streamline order of documentation for first time users (broad -> specific) - document resolver quirks * explict imports from graphene * rename doc refs for resolvers * suggestions typos and graphene import 2019-06-10 02:49:56 +03:00			* Flask-Graphql (`source <https://github.com/graphql-python/flask-graphql>`_)
Added inter docs 2016-09-21 10:51:57 +03:00			* `Graphene-SQLAlchemy <http://docs.graphene-python.org/projects/sqlalchemy/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-sqlalchemy/>`_)
			* `Graphene-GAE <http://docs.graphene-python.org/projects/gae/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-gae/>`_)
add Graphene-Mongo to intergrations list The Graphene-Mongo integration is missing from the intergration index. So I added the Graphene-Mongo docs to the integration index. 2018-04-12 04:38:48 +03:00			* `Graphene-Mongo <http://graphene-mongo.readthedocs.io/en/latest/>`_ (`source <https://github.com/graphql-python/graphene-mongo>`_)
Add FastAPI and Starlette to integrations (#906) 2019-03-11 20:03:54 +03:00			* `Starlette <https://www.starlette.io/graphql/>`_ (`source <https://github.com/encode/starlette>`_)
Docs: integrations: fix FastAPI link (#1177) 2020-04-09 21:21:04 +03:00			* `FastAPI <https://fastapi.tiangolo.com/advanced/graphql/>`_ (`source <https://github.com/tiangolo/fastapi>`_)