File: schemas.rst

package info (click to toggle)
python-validate-pyproject 0.24.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,340 kB
  • sloc: python: 3,053; makefile: 46; sh: 25
file content (33 lines) | stat: -rw-r--r-- 1,037 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
=======
Schemas
=======

The following sections represent the schemas used in ``validate-pyproject``.
They were automatically rendered via `sphinx-jsonschema`_ for quick reference.
In case of doubts or confusion, you can also have a look on the raw JSON files
in :doc:`json-schemas`.

.. _pyproject.toml:
.. jsonschema:: ../src/validate_pyproject/pyproject_toml.schema.json


.. _project_table:
.. jsonschema:: ../src/validate_pyproject/project_metadata.schema.json


``tool`` table
==============

According to :pep:`518`, tools can define their own configuration inside
``pyproject.toml`` by using custom subtables under ``tool``.

In ``validate-pyproject``, schemas for these subtables can be specified
via :ref:`plugins`. The following subtables are defined by *built-in* plugins
(i.e.  plugins that are included in the default distribution of
``validate-pyproject``):

.. _tool.setuptools:
.. jsonschema:: ../src/validate_pyproject/plugins/setuptools.schema.json


.. _sphinx-jsonschema: https://pypi.org/project/sphinx-jsonschema/