diff --git a/README.md b/README.md index 6f085d01..8b5a83e3 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,11 @@ If you want to learn even more, you can also check the following [examples](exam - **Basic Schema**: [Starwars example](examples/starwars) - **Relay Schema**: [Starwars Relay example](examples/starwars_relay) +## Documentation + +Documentation and links to additional resources are available at +https://docs.graphene-python.org/en/latest/ + ## Contributing After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running: @@ -177,7 +182,7 @@ tox -e py36 Tox can only use whatever versions of python are installed on your system. When you create a pull request, Travis will also be running the same tests and report the results, so there is no need for potential contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make graphene even more stable & useful! -### Documentation +### Building Documentation The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme. diff --git a/README.rst b/README.rst index a32b9321..5b3f3747 100644 --- a/README.rst +++ b/README.rst @@ -267,6 +267,12 @@ If you want to learn even more, you can also check the following - **Relay Schema**: `Starwars Relay example `__ +Documentation +------------- + +Documentation and links to additional resources are available at +https://docs.graphene-python.org/en/latest/ + Contributing ------------ @@ -324,7 +330,7 @@ contributors to try to install every single version of python on their own system ahead of time. We appreciate opening issues and pull requests to make graphene even more stable & useful! -Documentation +Building Documentation ~~~~~~~~~~~~~ The documentation is generated using the excellent diff --git a/docs/execution/middleware.rst b/docs/execution/middleware.rst index 55efe730..f7dac708 100644 --- a/docs/execution/middleware.rst +++ b/docs/execution/middleware.rst @@ -29,7 +29,7 @@ This middleware only continues evaluation if the ``field_name`` is not ``'user'` .. code:: python class AuthorizationMiddleware(object): - def resolve(self, next, root, info, **args): + def resolve(next, root, info, **args): if info.field_name == 'user': return None return next(root, info, **args) diff --git a/docs/types/scalars.rst b/docs/types/scalars.rst index b6e8f654..b4552cfb 100644 --- a/docs/types/scalars.rst +++ b/docs/types/scalars.rst @@ -39,9 +39,8 @@ Graphene defines the following base Scalar Types: ``graphene.Int`` Represents non-fractional signed whole numeric - values. Int can represent values between `-(2^53 - 1)` and `2^53 - 1` since - represented in JSON as double-precision floating point numbers specified - by `IEEE 754 `_. + values. Int is a signed 32‐bit integer per the + `GraphQL spec `_ ``graphene.Float``