sphinx-graphql

sphinx-graphql

|code_ci| |docs_ci| |coverage| |pypi_version| |license|

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

.. |code_ci| image:: https://github.com/dls-controls/sphinx-graphql/workflows/Code%20CI/badge.svg?branch=master :target: https://github.com/dls-controls/sphinx-graphql/actions?query=workflow%3A%22Code+CI%22 :alt: Code CI

.. |docs_ci| image:: https://github.com/dls-controls/sphinx-graphql/workflows/Docs%20CI/badge.svg?branch=master :target: https://github.com/dls-controls/sphinx-graphql/actions?query=workflow%3A%22Docs+CI%22 :alt: Docs CI

.. |coverage| image:: https://codecov.io/gh/dls-controls/sphinx-graphql/branch/master/graph/badge.svg :target: https://codecov.io/gh/dls-controls/sphinx-graphql :alt: Test Coverage

.. |pypi_version| image:: https://img.shields.io/pypi/v/sphinx-graphql.svg :target: https://pypi.org/project/sphinx-graphql :alt: Latest PyPI version

.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :target: https://opensource.org/licenses/Apache-2.0 :alt: Apache License

.. Anything below this line is used when viewing README.rst and will be replaced when included in index.rst

See https://dls-controls.github.io/sphinx-graphql for more detailed documentation.