| Name | autogqlschema JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | A Sphinx extension for automatically documenting GraphQL schemas. |
| upload_time | 2023-11-13 00:22:52 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
autogqlschema
==============
.. image:: https://readthedocs.org/projects/autogqlschema/badge/?version=latest
:target: https://autogqlschema.readthedocs.org
:alt: Documentation
.. image:: https://github.com/AWhetter/autogqlschema/actions/workflows/main.yml/badge.svg?branch=main
:target: https://github.com/AWhetter/autogqlschema/actions/workflows/main.yml?query=branch%3Amain
:alt: Github Build Status
.. image:: https://img.shields.io/pypi/v/autogqlschema.svg
:target: https://pypi.org/project/autogqlschema/
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/autogqlschema.svg
:target: https://pypi.org/project/autogqlschema/
:alt: Supported Python Versions
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/python/black
:alt: 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 <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
Installation
~~~~~~~~~~~~
``autogqlschema`` can be installed through pip:
.. code-block:: bash
pip install autogqlschema
Next, add ``autogqlschema`` to the ``extensions`` list in your Sphinx project's `conf.py`.
.. code-block:: python
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.
.. code-block:: none
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:
.. code-block:: rst
.. autogqlschema::
:root-dir: ../src/mypackage/schema
:source-files: *.graphql
Or:
.. code-block:: rst
.. 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 <https://tox.readthedocs.io/en/latest/>`_.
.. code-block:: bash
tox
Code Style
~~~~~~~~~~
Code is formatted using `black <https://github.com/python/black>`_.
You can check your formatting using black's check mode:
.. code-block:: bash
tox -e format
You can also get black to format your changes for you:
.. code-block:: bash
tox -e format -- src/ tests/
Release Notes
~~~~~~~~~~~~~
Release notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.
When making a pull request you will need to create a news fragment to document your change:
.. code-block:: bash
tox -e release_notes -- create --help
Versioning
----------
We use `SemVer <https://semver.org/>`_ for versioning.
For the versions available, see the `tags on this repository <https://github.com/AWhetter/autogqlschema/tags>`_.
License
-------
This project is licensed under the MIT License.
See the `LICENSE.rst <LICENSE.rst>`_ file for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "autogqlschema",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Ashley Whetter <ashley@awhetter.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/53/e1/dffa1ae063c7093fff6bab5ef73c4d1e05da9fb64d40bb9cdd1839a2f341/autogqlschema-0.2.0.tar.gz",
"platform": null,
"description": "autogqlschema\n==============\n\n.. image:: https://readthedocs.org/projects/autogqlschema/badge/?version=latest\n :target: https://autogqlschema.readthedocs.org\n :alt: Documentation\n\n.. image:: https://github.com/AWhetter/autogqlschema/actions/workflows/main.yml/badge.svg?branch=main\n :target: https://github.com/AWhetter/autogqlschema/actions/workflows/main.yml?query=branch%3Amain\n :alt: Github Build Status\n\n.. image:: https://img.shields.io/pypi/v/autogqlschema.svg\n :target: https://pypi.org/project/autogqlschema/\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/autogqlschema.svg\n :target: https://pypi.org/project/autogqlschema/\n :alt: Supported Python Versions\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/python/black\n :alt: Formatted with Black\n\nA Sphinx extension for automatically documenting GraphQL schemas.\n\n\nGetting Started\n---------------\n\nThe following steps will walk through how to add ``autogqlschema`` to an existing Sphinx project.\nFor instructions on how to set up a Sphinx project,\nsee Sphinx's documentation on\n`Getting Started <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.\n\n\nInstallation\n~~~~~~~~~~~~\n\n``autogqlschema`` can be installed through pip:\n\n.. code-block:: bash\n\n pip install autogqlschema\n\nNext, add ``autogqlschema`` to the ``extensions`` list in your Sphinx project's `conf.py`.\n\n.. code-block:: python\n\n extensions.append(\"autogqlschema\")\n\n\nUsage\n-----\n\nSchema documentation is generated from GraphQL schema files using the ``autogqlschema`` directive.\n\nIn the following example, documentation is generated from ths file structure.\n\n.. code-block:: none\n\n myrepo\n \u251c\u2500\u2500 doc\n \u2502 \u251c\u2500\u2500 conf.py\n \u2502 \u2514\u2500\u2500 index.rst\n \u2514\u2500\u2500 src\n \u2514\u2500\u2500 mypackage\n \u251c\u2500\u2500 schema\n \u2502 \u251c\u2500\u2500 __init__.py\n \u2502 \u251c\u2500\u2500 01_schema.graphql\n \u2502 \u2514\u2500\u2500 02_books.graphql\n \u2514\u2500\u2500 __init__.py\n\nThis schema can be generated with the following reStructuredText:\n\n.. code-block:: rst\n\n .. autogqlschema::\n :root-dir: ../src/mypackage/schema\n :source-files: *.graphql\n\nOr:\n\n.. code-block:: rst\n\n .. autogqlschema::\n :root-dir: ../src/mypackage/schema\n :source-files: 01_schema.graphql, 02_books.graphql\n\nFor more detailed usage, see the documentation:\nhttps://autogqlschema.readthedocs.io/en/latest/\n\n\nContributing\n------------\n\nRunning the tests\n~~~~~~~~~~~~~~~~~\n\nTests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.\n\n.. code-block:: bash\n\n tox\n\n\nCode Style\n~~~~~~~~~~\n\nCode is formatted using `black <https://github.com/python/black>`_.\n\nYou can check your formatting using black's check mode:\n\n.. code-block:: bash\n\n tox -e format\n\nYou can also get black to format your changes for you:\n\n.. code-block:: bash\n\n tox -e format -- src/ tests/\n\n\nRelease Notes\n~~~~~~~~~~~~~\n\nRelease notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.\nWhen making a pull request you will need to create a news fragment to document your change:\n\n.. code-block:: bash\n\n tox -e release_notes -- create --help\n\n\nVersioning\n----------\n\nWe use `SemVer <https://semver.org/>`_ for versioning.\nFor the versions available, see the `tags on this repository <https://github.com/AWhetter/autogqlschema/tags>`_.\n\n\nLicense\n-------\n\nThis project is licensed under the MIT License.\nSee the `LICENSE.rst <LICENSE.rst>`_ file for details.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Sphinx extension for automatically documenting GraphQL schemas.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://autogqlschema.readthedocs.org",
"Source": "https://github.com/AWhetter/autogqlschema"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b66fc3fb3355bf78aeef6a288f8eda93739c2ef2dc8cb6dfc4c0f5690889429a",
"md5": "28fb314fab829ac6e087af2fa8717527",
"sha256": "813fb13fa2befc7c90b6037fa64bbe8b80d367844dbff201865e704d060196a4"
},
"downloads": -1,
"filename": "autogqlschema-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28fb314fab829ac6e087af2fa8717527",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13049,
"upload_time": "2023-11-13T00:22:50",
"upload_time_iso_8601": "2023-11-13T00:22:50.798992Z",
"url": "https://files.pythonhosted.org/packages/b6/6f/c3fb3355bf78aeef6a288f8eda93739c2ef2dc8cb6dfc4c0f5690889429a/autogqlschema-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53e1dffa1ae063c7093fff6bab5ef73c4d1e05da9fb64d40bb9cdd1839a2f341",
"md5": "4e70933ff618f23e96ca968ba29ab75d",
"sha256": "8f527535586c2178e83eb48f11072718e4ca45e6fb66c09dd6272b9a9607e751"
},
"downloads": -1,
"filename": "autogqlschema-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "4e70933ff618f23e96ca968ba29ab75d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9505,
"upload_time": "2023-11-13T00:22:52",
"upload_time_iso_8601": "2023-11-13T00:22:52.345284Z",
"url": "https://files.pythonhosted.org/packages/53/e1/dffa1ae063c7093fff6bab5ef73c4d1e05da9fb64d40bb9cdd1839a2f341/autogqlschema-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 00:22:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AWhetter",
"github_project": "autogqlschema",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "autogqlschema"
}
