autogqlschema 0.2.0

入门

以下步骤将指导您如何将autogqlschema添加到现有的Sphinx项目中。有关如何设置Sphinx项目的说明，请参阅Sphinx的入门文档。

pip install autogqlschema

extensions.append("autogqlschema")

使用方法

模式文档是通过使用autogqlschema指令从GraphQL模式文件生成的。

在以下示例中，文档是从以下文件结构生成的。

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

可以使用以下reStructuredText生成此模式

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

或者

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

有关更详细的使用说明，请参阅文档： https://autogqlschema.readthedocs.io/en/latest/

贡献

tox

tox -e format

tox -e format -- src/ tests/

tox -e release_notes -- create --help

版本控制

我们使用SemVer进行版本管理。有关可用的版本，请参阅此存储库上的标签。

许可证

本项目采用MIT许可证。有关详细信息，请参阅LICENSE.rst文件。