Commit Graph

270 Commits

Author SHA1 Message Date
Jonathan Kim
abe547fb4d
Fix wrong variable name (#1015)
Resolves #1014
2019-06-22 18:09:52 +02:00
David Anderson
5cb7d91aaa 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-09 16:49:56 -07:00
David Anderson
da1359ecca 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-09 15:36:06 -07:00
Ambro
40229b8a73 Fix internal link on docs (#980) 2019-06-04 09:23:24 -07:00
Mike Bobadilla
1fcdeaac65 Typo in documentation (#975) 2019-05-28 10:09:57 -07:00
Ganesh Pandey
daf0d17647 fix type on docs (#939) 2019-04-09 11:29:40 -07:00
Eran Kampf
bcbb66c025
Line too long in code sample caused docs UI to overflow (#938) 2019-04-08 13:59:39 -07:00
Eran Kampf
582ac59bf7 Another docs test 2019-04-08 12:36:35 -07:00
Eran Kampf
28f6b18f55 Small formatting fix to test docs integration 2019-04-08 12:33:29 -07:00
Jonathan Kim
c5b2281e22 Update execution doc with correct way to use variables (#920)
* Fix issue #890

* Change to `root`
2019-03-27 16:44:41 -07:00
Jonathan Kim
21cccf4c96 Update object type docs (#921)
Now that the default resolver handles both objects and dicts
2019-03-17 12:43:49 -07:00
Jonathan Kim
0805436d45
Docs on changing the name of an ObjectType (#922)
Fixes https://github.com/graphql-python/graphene/issues/839
2019-03-16 21:58:49 +00:00
Sebastián Ramírez
bbe11c9b5e Add FastAPI and Starlette to integrations (#906) 2019-03-11 10:03:54 -07:00
Markus Holtermann
96d497c2b8 Fix docs on graphene.Int bounds (#891) 2019-03-11 09:32:23 -07:00
Jonathan Kim
a4681ce6b2
Fixes middleware documentation (#916)
Closes #812
2019-03-10 16:21:08 +01:00
Jonathan Kim
e1a2eb5a35 Remove trailing whitespace 2018-12-26 20:32:22 +00:00
Jonathan Kim
349add5700 Update documentation on ObjectTypes
Resolves #798
2018-12-26 20:22:34 +00:00
Syrus Akbary
08c86f3def
Merge pull request #845 from nive/master
quickstart example improvement
2018-11-05 20:26:18 +01:00
Johan Zietsman
587ce5ae93
Update interfaces.rst 2018-10-30 14:23:29 +02:00
Johan Zietsman
52f54f51b2
Update objecttypes.rst 2018-10-30 14:17:44 +02:00
Johan Zietsman
95cfff8c37
Update enums.rst 2018-10-30 14:06:37 +02:00
Syrus Akbary
7cfc3ffe67
Merge pull request #850 from MarSoft/patch-1
Fix typo in docs
2018-10-26 19:16:03 +02:00
Syrus Akbary
83a5587d71
Merge pull request #851 from etandel/feature/dataloader-docs
Improve dataloader doc
2018-10-26 19:15:44 +02:00
Elias Tandel Barrionovo
21dbaa93c4 Improve dataloader doc
Explicitly mention that loaded values must have the same order as the
given keys
2018-10-23 10:05:47 -03:00
Семён Марьясин
ca02095806
Fix typo in docs 2018-10-22 16:19:55 +03:00
Christian González
4752ec08ab
fix deprecated "Input" class 2018-10-20 11:16:29 +02:00
adroullier
85e6c3d3fb quickstart example improvement, rename name parameter of String field to argument 2018-10-16 13:59:25 +02:00
Derek Schaller
3df3754ae6 inline doctstring of make targets 2018-10-13 11:21:07 -07:00
Adam Johnson
7dd8305bdf Change deprecated execute() arguments to new ones
Changed in https://github.com/graphql-python/graphql-core/pull/185 , the docs here were out of date, as were the tests.
2018-08-29 12:35:44 +03:00
Daniel Gallagher
086f9dda99 Run black formatter via pre-commit on all files 2018-07-06 12:09:23 -07:00
Ben Mosher
708278e6dc
docs: mutation 'Output' example (closes #543) 2018-06-26 07:14:46 -04:00
Syrus Akbary
9efdf4c46e
Merge pull request #771 from jkimbo/update-interface-documentation
Update interface documentation
2018-06-18 13:33:59 -07:00
Jonathan Kim
cc54c76a3e Improve wording 2018-06-17 12:05:34 +01:00
Jonathan Kim
e7ebb86e5a Re-order type list 2018-06-17 11:25:32 +01:00
Jonathan Kim
a2db7c5dae Remove an unnecessary field 2018-06-17 11:24:59 +01:00
Jonathan Kim
3f6c3a7a99 Clean up doc and add resolve_type documentation 2018-06-17 11:23:08 +01:00
Jonathan Kim
43e87768d2 Update interface documentation 2018-06-16 15:10:32 +01:00
Raphael Boidol
5c4736e102 Update documentation
* resolver function arguments changed in `objecttypes.rst`
* small typo in `mutations.rst`
2018-06-16 13:11:33 +02:00
Dan
f13e54b4a4 Update contributing docs about using tox and sync tox pytest cmd with travis (#744)
* Update pytest command run by tox to match the command used by travis. Updated README contributing section with info about using tox to run tests.

* Uppercase 'Graphene'
2018-05-30 12:53:44 +01:00
Dan
034b5385a5 Add isort precommit hook & run on all files (#743)
* Add isort and seed-isort-config pre-commit hook

* Fix erroneous isort moving comment to the top of file
2018-05-28 19:18:54 +01:00
Lewis
7d998f0844
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 10:38:48 +09:00
Syrus Akbary
d6df14923d
Updated docs template 2018-03-13 22:37:36 -07:00
Jonathan Kim
d3b708533d Fix kwarg name in example. Fixes #533 2018-02-17 23:28:33 +00:00
Jonathan Kim
e26c0a3717 Add documentation on NonNull lists 2018-02-07 12:06:29 -08:00
Dean Kleissas
035ff7ef88 Update middleware example to support introspection
In the `timing_middleware` example, introspection queries will fail due to `Schema` and others not having `_meta` attributes. API will work and tests pass but introspection will fail, which can be quite confusing to the developer. Simple update makes sure the `root` variable has a `_meta` attribute before accessing it.
2018-01-24 16:48:14 -05:00
Syrus Akbary
8123c4ad8f
Fix relay links. 2018-01-20 15:17:52 -08:00
Simon Wörpel
7afeaa052b
Docs: fix typos in example for relay nodes 2017-12-16 00:03:36 +01:00
Jonathan Kim
0a6921d2d0 Add extra documentation on base scalars 2017-12-10 16:07:48 +01:00
Jonathan Kim
76f8a35916 Add documentation for scalar type arguments 2017-12-10 15:53:28 +01:00
Jonathan Kim
502597c5a4 Format duration 2017-12-08 15:03:20 +00:00
Jonathan Kim
27745078bc Document functional middleware 2017-12-08 14:58:03 +00:00
Grégoire Chauvet
98366c6add
Added Date scalar to documentation 2017-11-29 14:32:17 +01:00
Syrus Akbary
375d1f494b
Merge pull request #606 from g--/patch-1
Relay documentation reflects api changes in 2.0
2017-11-26 17:48:43 -08:00
Dan Palmer
834d52f9d3
Use more Pythonic terminology here
"Hash" in the Python world implies a cryptographic hash, or possibly a checksum. Here, I believe "hash" is being used to mean "hash map", which would be more commonly known in Python as a dictionary, or dict for short.
2017-11-25 12:51:53 +00:00
Geoff
ec32c252e7
Relay documentation reflects api changes in 2.0
Specifically, get_node_from_global_id.
2017-11-20 10:05:28 -05:00
Stan Zhavoronkov
3412dba31f
fix Unions.rst
fix Unions.rst docs (copy-paste sentence from interfaces.rst).
2017-11-14 13:04:47 +03:00
Syrus Akbary
71d5b1d943
Merge pull request #587 from ekampf/feature/enum_docs_update
Improved docs for Enums
2017-11-02 22:00:23 -07:00
Eran Kampf
1555c988e0 Fix resolve arguments section according to 2.0 resolvers 2017-10-30 14:31:20 -07:00
Eran Kampf
7f59a8fa7e Added docs 2017-10-30 13:05:02 -07:00
Vincent Poulailleau
98c2af3fcc
fix access to the request in Django
With the current documentation, I get after execution:
"graphql.error.located_error.GraphQLLocatedError: name 'context' is not defined"

I don't get any error after the correction I made (I haven't yet tried to upload a file…)
2017-10-30 16:00:18 +01:00
Varun Dey
ef507c7932 Fixed minor grammatical error 2017-10-27 15:58:32 +05:30
Syrus Akbary
34d03a7bd2 Updated docs to use stable version of Graphene 2.0 2017-10-26 00:22:59 -07:00
Syrus Akbary
7b08dbd2a1 Merge pull request #560 from nikolas/patch-1
quickstart: use print function in example query
2017-10-05 11:38:06 +02:00
Frankie Robertson
a1bc7377bd Add unions doc to index 2017-10-05 11:50:09 +03:00
Nik Nyby
37fbbf55fa quickstart: use print function in example query 2017-10-04 23:09:18 -04:00
Mandeep Singh
b34b3091d4 fix typo in Enum docs 2017-09-03 20:38:06 +05:30
Syrus Akbary
7455063728 Fixed mutation docs (adding missing info arg in mutate) 2017-08-29 09:26:20 -07:00
Syrus Akbary
1d52148b37 Update quickstart.rst 2017-08-27 16:06:35 -07:00
Syrus Akbary
6a85507325 Improved get_node API 2017-07-27 20:06:48 -07:00
Syrus Akbary
0002d42e38 Updated docs 2017-07-27 03:05:58 -07:00
Syrus Akbary
e6b0cbb3bc Merge branch 'master' into 2.0 2017-07-26 22:46:26 -07:00
Syrus Akbary
a56d5d9f77 Added union docs. Fixed #493 2017-07-26 22:43:22 -07:00
Syrus Akbary
fa512cfa50 Improved mutation docs 2017-07-26 22:36:27 -07:00
Syrus Akbary
33a30db5f1 Improved quickstart docs 2017-07-24 00:01:44 -07:00
Syrus Akbary
0e355ee296 Improved documentation examples 2017-07-23 23:29:27 -07:00
Thibaut Fatus
c155b7a56e Doc was missing for using variables in queries
added an example
2017-07-12 18:52:46 +02:00
XatMassacrE
dc5de1f503 Fix doc typo 2017-07-11 11:08:39 +08:00
XatMassacrE
93fc03d9e0 Fix doc typo 2017-07-11 10:27:36 +08:00
Vincent Fretin
9d30136095 Fix typo Grapehne -> Graphene 2017-05-17 11:05:53 +02:00
Ryan Ashcraft
0a9dbb608a Fix typo in dataloader docs 2017-05-15 19:06:23 -07:00
Syrus Akbary
23e028fe72 Merge pull request #460 from yixizhang/typo
fix typo in docs/execution
2017-04-26 23:58:17 -07:00
Yixi Zhang
bad6f5a188 fix typo in docs/execution 2017-04-26 16:27:44 -07:00
Michael Chen
5052536787 Update Relay Documentation Link
Update the link of Relay Specification to Facebook Relay Specifications
2017-04-26 11:45:36 -07:00
Syrus Akbary
082186c169 Added dataloader docs 2017-04-20 00:53:17 -07:00
Syrus Akbary
b71a2cb69e Fixed middleware docs to use whitespaces instead of tabs 2017-04-20 00:34:05 -07:00
Kuan
06757f10c6 Update basic schema with arguments 2017-04-13 10:32:49 -07:00
Syrus Akbary
b8323ed8e7 Merge pull request #446 from graphql-python/features/improved-enums
Improved enums comparison and getters
2017-04-12 23:26:52 -07:00
Syrus Akbary
038f81e8e1 Added extra parameters section in testing docs
@BossGrand 😉
2017-04-10 16:18:45 -07:00
Syrus Akbary
60e29028a8 Added testing docs 2017-04-10 00:48:06 -07:00
Syrus Akbary
afed25a180 Improved enums comparison and getters. Fixed #444 2017-04-07 22:02:16 -07:00
Grigoriy Beziuk
d86bbd8a86 a fypo fixed so the hyperlink to the graphQL official introduction is shown now 2017-03-10 11:05:01 +03:00
Syrus Akbary
d5960a7630 Merge pull request #427 from nattyait/requirements
Add Sphinx to requirements for building graphene docs
2017-03-01 09:41:27 -08:00
Syrus Akbary
5e7002ce76 Merge pull request #429 from ryanwilsonperkin/patch-1
Spelling/Grammar fixes in docs
2017-03-01 09:40:54 -08:00
Ryan Wilson-Perkin
313a004141 Spelling/Grammar fixes in docs
Hi, thanks for writing these docs! I'm reading through them and hoping to give back by fixing up some spelling and grammatical issues.
2017-03-01 09:30:39 -05:00
Chapman Siu
3a198d052a fixed indent in mutation docs 2017-03-01 22:54:06 +11:00
nattyait
e405a20e3d Add Sphinx to requirements for building graphene docs 2017-03-01 16:11:04 +07:00
Syrus Akbary
e2cdd80a5c Added docs for List and NonNull types. Fixed #326 2017-02-20 22:44:27 -08:00
Syrus Akbary
8b0cd488d4 Improved Mutation docs. Fixed #402 2017-02-20 22:12:55 -08:00
Syrus Akbary
b5cc0a81da Improved scalar docs. Fixed #394 2017-02-20 21:57:39 -08:00
Syrus Akbary
8dff91d4c6 Fix typos in Node docs. 2017-02-08 08:21:14 -08:00