Skip to content
This repository was archived by the owner on Feb 23, 2022. It is now read-only.
This repository was archived by the owner on Feb 23, 2022. It is now read-only.

Produce automated documentation for GraphQL "language" #8

Closed

Description

@waxlamp

i.e. find some software that can read an annotated GraphQL spec and generate documentation for it.

Activity

  1. waxlamp commented on Jun 21, 2019

    @waxlamp
    ContributorAuthor

    GraphQL supports directly documenting types, queries, etc., along with their fields, by simply putting string or block string literals before each item:

    """
    Type documentation goes here.
    """
    type Foobar {
      .
      .
      .
    }

    The Python GraphQL engine we're using doesn't support parsing these just yet, but there's a PR on a fork: graphql-python/graphql-core#222. If and when this lands we can take care of this issue.

  2. self-assigned this
    on Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

wontfixThis will not be worked on

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions