autogqlschema
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.
Metadata
Release files for autogqlschema 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| autogqlschema-1.0.1.tar.gz | 22.1 kB | With provenance | Details for autogqlschema-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| autogqlschema-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for autogqlschema-1.0.1-py3-none-any.whl |
Total release size: 36.1 kB
Release files / autogqlschema-1.0.1.tar.gz
| Download URL | autogqlschema-1.0.1.tar.gz |
|---|---|
| Size | 22.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fc9b4ecdf7455ef5c22877d931179f12ca529db90834d916d3d4f5675aa033f4
|
|
BLAKE2b-256 checksum How to use checksums |
ba4f35075d011fdd62b6e5fc28861007aec208a351d885085d67187018a59e72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.
Transparency logRelease files / autogqlschema-1.0.1-py3-none-any.whl
| Download URL | autogqlschema-1.0.1-py3-none-any.whl |
|---|---|
| Size | 14.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d06cb2b39851602e0c1f87b5919c8fe84ea758b16de7679f22fd004dd6375008
|
|
BLAKE2b-256 checksum How to use checksums |
0c838278012713b49cf34b120bd2c7088bb61efaacf06432fb3edcc60ea5ff81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.
Transparency logSecurity for autogqlschema 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for autogqlschema-1.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.