Skip to main content

A Sphinx extension for automatically documenting GraphQL schemas.

Project description

Documentation Github Build Status PyPI Version Supported Python Versions Formatted with Black

A Sphinx extension for automatically documenting GraphQL schemas.

Getting Started

The following steps will walk through how to add autogqlschema to an existing Sphinx project. For instructions on how to set up a Sphinx project, see Sphinx’s documentation on Getting Started.

Installation

autogqlschema can be installed through pip:

pip install autogqlschema

Next, add autogqlschema to the extensions list in your Sphinx project’s conf.py.

extensions.append("autogqlschema")

Usage

Schema documentation is generated from GraphQL schema files using the autogqlschema directive.

In the following example, documentation is generated from ths file structure.

myrepo
├── doc
│   ├── conf.py
│   └── index.rst
└── src
    └── mypackage
        ├── schema
        │   ├── __init__.py
        │   ├── 01_schema.graphql
        │   └── 02_books.graphql
        └── __init__.py

This schema can be generated with the following reStructuredText:

.. autogqlschema::
   :root-dir: ../src/mypackage/schema
   :source-files: *.graphql

Or:

.. autogqlschema::
   :root-dir: ../src/mypackage/schema
   :source-files: 01_schema.graphql, 02_books.graphql

For more detailed usage, see the documentation: https://autogqlschema.readthedocs.io/en/latest/

Contributing

Running the tests

Tests are executed through tox.

tox

Code Style

Code is formatted using black.

You can check your formatting using black’s check mode:

tox -e format

You can also get black to format your changes for you:

tox -e format -- src/ tests/

Release Notes

Release notes are managed through towncrier. When making a pull request you will need to create a news fragment to document your change:

tox -e release_notes -- create --help

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License. See the LICENSE.rst file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autogqlschema-0.2.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

autogqlschema-0.2.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file autogqlschema-0.2.0.tar.gz.

File metadata

  • Download URL: autogqlschema-0.2.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for autogqlschema-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8f527535586c2178e83eb48f11072718e4ca45e6fb66c09dd6272b9a9607e751
MD5 4e70933ff618f23e96ca968ba29ab75d
BLAKE2b-256 53e1dffa1ae063c7093fff6bab5ef73c4d1e05da9fb64d40bb9cdd1839a2f341

See more details on using hashes here.

Provenance

File details

Details for the file autogqlschema-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for autogqlschema-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 813fb13fa2befc7c90b6037fa64bbe8b80d367844dbff201865e704d060196a4
MD5 28fb314fab829ac6e087af2fa8717527
BLAKE2b-256 b66fc3fb3355bf78aeef6a288f8eda93739c2ef2dc8cb6dfc4c0f5690889429a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page