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

Produce automated documentation for GraphQL "language" #8

Closed
waxlamp opened this issue Apr 3, 2019 · 1 comment · Fixed by #148
Closed

Produce automated documentation for GraphQL "language" #8

waxlamp opened this issue Apr 3, 2019 · 1 comment · Fixed by #148
Assignees
Labels
wontfix This will not be worked on

Comments

@waxlamp
Copy link
Collaborator

waxlamp commented Apr 3, 2019

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

@waxlamp
Copy link
Collaborator Author

waxlamp commented Jun 21, 2019

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.

@waxlamp waxlamp self-assigned this Aug 13, 2019
@waxlamp waxlamp added the wontfix This will not be worked on label Aug 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant