Metadata-Version: 2.1
Name: django-graphqldoc
Version: 0.1.1
Summary: GraphQLdoc is a simple Django app to document GraphQL schemas.
Home-page: https://github.com/thecylax/django-graphqldoc
Author: Robson Cardoso dos Santos
Author-email: cardoso.rcs@gmail.com
License: BSD License
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
Requires-Dist: gql

# GraphQLdoc

GraphQLdoc is a simple Django app to document GraphQL schemas.

## Quick start
1. Add **graphqldoc** to your INSTALLED_APPS setting like this:

        INSTALLED_APPS = [
            ...
            'graphqldoc',
        ]

2. Add GRAPHQLDOC config settings in your settings file, and configure according to your needs, like this:

        GRAPHQLDOC = {
            'LOGO_URL': 'https://graphql.org/img/logo.svg',
            'TITLE': 'My GraphQL documentation',
        }

   This step is optional, it changes the logo and the default title in the template.

3. Include the graphqldoc URLconf in your project `urls.py` like this:

        path('docs/', include('graphqldoc.urls')),

4. Start the development server and visit http://localhost:8000/docs/ to view the rendered documentation for your GraphQL server.


