Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support piped input for generating documentation #255

Open
robross0606 opened this issue Nov 17, 2020 · 1 comment
Open

Support piped input for generating documentation #255

robross0606 opened this issue Nov 17, 2020 · 1 comment

Comments

@robross0606
Copy link

robross0606 commented Nov 17, 2020

For automation purposes, it would ben useful to be able to pipe IDL input into the tool versus having to write out a temporary file and then pointing the tool to that file (IDL, etc.).

For example:

npm run schema:out | npx graphdoc -p -o ./doc/graphdoc
@robross0606
Copy link
Author

robross0606 commented Nov 17, 2020

This may already be possible somehow, but the documentation is extremely vague and looks slightly corrupt and possibly outdated in the README:

Generate documentation from for the "modularized
schema"
of graphql-tools

graphdoc -s ./schema.js -o ./doc/schema
./schema.graphql must be able to be interpreted with graphql-js/utilities#buildSchema

It is very unclear what is expected out of ./schema.js.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant