graphqldomain 0.2.0

入门

以下步骤将说明如何将graphqldomain添加到现有的Sphinx项目中。有关如何设置Sphinx项目的说明，请参阅Sphinx的入门文档。

pip install graphqldomain

extensions.append("graphqldomain")

用法

每个指令都接受原始模式的片段。有关更详细的用法，请参阅文档：https://graphqldomain.readthedocs.io/en/latest/

.. gql:schema::

   An example schema.

   :optype Query query:

   .. gql:directive:: @slow(super: Boolean = false) on FIELD_DEFINITION | ARGUMENT_DEFINITION

      Indicates that the usage of this field or argument is slow,
      and therefore queries with this field or argument should be made sparingly.

      :argument super: Whether usage will be super slow, or just a bit slow.

   .. gql:enum:: CharacterCase

      The casing of a character.

      .. gql:enum:value:: UPPER

         Upper case.

      .. gql:enum:value:: LOWER

         Lower case.

   .. gql:input:: Point2D

      A point in a 2D coordinate system.

      .. gql:input:field:: x: Float

         The ``x`` coordinate of the point.

      .. gql:input:field:: y: Float

         The ``y`` coordinate of the point.

   .. gql:interface:: NamedEntity

      An entity with a name.

      .. gql:interface:field:: name(lower: Boolean = false): String

         The name of the entity.

         :argument lower: Whether to lowercase the name or not.

   .. gql:type:: Person implements NamedEntity

      A human person.

      .. gql:type:field:: age: Int

         How old the person is in years.

      .. gql:type:field:: picture: Url

   .. gql:union:: Centre = Person | Point2D

      A possible centre of the universe.

贡献

tox

tox -e format

black graphqldomain.py tests/

版本控制

我们使用SemVer进行版本控制。有关可用的版本，请参阅此存储库的标签。

许可证

此项目受MIT许可证的许可。有关详细信息，请参阅LICENSE.rst文件。