Skip to content

Commit fdca470

Browse files
committed
BLD: Setup the pydantic config
1 parent e88a2ac commit fdca470

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

docs/source/asv.conf.json.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
.. _conf-reference:
22

3+
4+
.. autopydantic_model:: asv.schema.ASVConfig
5+
6+
37
``asv.conf.json`` reference
48
===========================
59

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@
1818
"sphinxcontrib.bibtex",
1919
"sphinx_collapse",
2020
"autoapi.extension",
21+
"sphinxcontrib.autodoc_pydantic",
2122
]
2223

2324
autoapi_dirs = ["../../asv"]
2425
autoapi_add_toc_entry = True
2526
autoapi_keep_files = True
26-
autoapi_ignore = ["*_version*", "*migrations*"]
27+
autoapi_ignore = ["*_version*", "*migrations*", "*schema*"]
2728
autoapi_options = [
2829
"members",
2930
"undoc-members",

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ dependencies = [
3333
"tabulate",
3434
"virtualenv",
3535
"packaging",
36+
"pydantic",
3637
"importlib-metadata",
3738
"tomli; python_version < '3.11'",
3839
"colorama; platform_system == 'Windows'",
@@ -70,6 +71,7 @@ doc = [
7071
"sphinxcontrib.bibtex",
7172
"setuptools", # dependency from bibtex
7273
"sphinxcontrib.katex",
74+
"autodoc-pydantic",
7375
"furo",
7476
]
7577
dev = [

0 commit comments

Comments
 (0)