sphinx-graphql¶

Sphinx utilities for documenting GraphQL APIs

PyPI	`pip install sphinx-graphql`
Source code	https://github.com/dls-controls/sphinx-graphql
Documentation	https://dls-controls.github.io/sphinx-graphql

This plugin provides an RST directive for generating GraphiQL views inside Spinx documentation. Code based on https://github.com/hasura/sphinx-graphiql

How the documentation is structured¶

Documentation is split into four categories, accessible from links in the side-bar.

Tutorials for installation, library and commandline usage. New users start here.

Practical step-by-step guides for the more experienced user.

Explanation of how the library works and why it works that way.

Technical reference material, for classes, methods, APIs, commands, and contributing to the project.