From 6eb98b58ba8785783bb537cfe6a128f6e42b9407 Mon Sep 17 00:00:00 2001 From: Viicos <65306057+Viicos@users.noreply.github.com> Date: Thu, 20 Nov 2025 17:12:09 +0100 Subject: [PATCH] Add `pydantic-docs` dev dependency --- mkdocs.yml | 1 + pyproject.toml | 4 +++- uv.lock | 17 +++++++++++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5f827ae71b..e61bdbf007 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -286,6 +286,7 @@ markdown_extensions: - pymdownx.tasklist: custom_checkbox: true - sane_lists # this means you can start a list from any number + - pydantic_docs.mdext watch: - pydantic_ai_slim diff --git a/pyproject.toml b/pyproject.toml index 3c13afdece..740a07e361 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -75,6 +75,7 @@ pydantic-ai-slim = { workspace = true } pydantic-evals = { workspace = true } pydantic-graph = { workspace = true } pydantic-ai-examples = { workspace = true } +pydantic-docs = { git = "https://github.com/pydantic/pydantic-docs" } [tool.uv.workspace] members = [ @@ -118,10 +119,11 @@ docs = [ "mkdocs>=1.6.1", "mkdocs-glightbox>=0.4.0", "mkdocs-llmstxt>=0.2.0", - 'mkdocs-redirects>=1.2.2', + "mkdocs-redirects>=1.2.2", "mkdocs-material[imaging]>=9.5.45", "mkdocstrings-python>=1.12.2", "griffe-warnings-deprecated>=1.1.0", + "pydantic-docs", ] docs-upload = ["algoliasearch>=4.12.0", "pydantic>=2.10.1"] diff --git a/uv.lock b/uv.lock index 62d3f22778..5f59c2f87d 100644 --- a/uv.lock +++ b/uv.lock @@ -5432,6 +5432,7 @@ docs = [ { name = "mkdocs-redirects" }, { name = "mkdocstrings-python" }, { name = "pydantic-ai", extra = ["a2a"] }, + { name = "pydantic-docs" }, ] docs-upload = [ { name = "algoliasearch" }, @@ -5490,6 +5491,7 @@ docs = [ { name = "mkdocs-redirects", specifier = ">=1.2.2" }, { name = "mkdocstrings-python", specifier = ">=1.12.2" }, { name = "pydantic-ai", extras = ["a2a"], editable = "." }, + { name = "pydantic-docs", git = "https://github.com/pydantic/pydantic-docs" }, ] docs-upload = [ { name = "algoliasearch", specifier = ">=4.12.0" }, @@ -5795,6 +5797,19 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/32/56/8a7ca5d2cd2cda1d245d34b1c9a942920a718082ae8e54e5f3e5a58b7add/pydantic_core-2.33.2-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:329467cecfb529c925cf2bbd4d60d2c509bc2fb52a20c1045bf09bb70971a9c1", size = 2066757, upload-time = "2025-04-23T18:33:30.645Z" }, ] +[[package]] +name = "pydantic-docs" +version = "0.0.1" +source = { git = "https://github.com/pydantic/pydantic-docs#142645b6ec056bbe2f39cc313aff781fba15e326" } +dependencies = [ + { name = "click" }, + { name = "markdown" }, + { name = "mkdocs" }, + { name = "mkdocs-material" }, + { name = "pymdown-extensions" }, + { name = "ruamel-yaml" }, +] + [[package]] name = "pydantic-evals" source = { editable = "pydantic_evals" } @@ -6742,6 +6757,8 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/6b/fa/3234f913fe9a6525a7b97c6dad1f51e72b917e6872e051a5e2ffd8b16fbb/ruamel.yaml.clib-0.2.14-cp314-cp314-macosx_15_0_arm64.whl", hash = "sha256:70eda7703b8126f5e52fcf276e6c0f40b0d314674f896fc58c47b0aef2b9ae83", size = 137970, upload-time = "2025-09-22T19:51:09.472Z" }, { url = "https://files.pythonhosted.org/packages/ef/ec/4edbf17ac2c87fa0845dd366ef8d5852b96eb58fcd65fc1ecf5fe27b4641/ruamel.yaml.clib-0.2.14-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:a0cb71ccc6ef9ce36eecb6272c81afdc2f565950cdcec33ae8e6cd8f7fc86f27", size = 739639, upload-time = "2025-09-22T19:51:10.566Z" }, { url = "https://files.pythonhosted.org/packages/15/18/b0e1fafe59051de9e79cdd431863b03593ecfa8341c110affad7c8121efc/ruamel.yaml.clib-0.2.14-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:e7cb9ad1d525d40f7d87b6df7c0ff916a66bc52cb61b66ac1b2a16d0c1b07640", size = 764456, upload-time = "2025-09-22T19:51:11.736Z" }, + { url = "https://files.pythonhosted.org/packages/e7/cd/150fdb96b8fab27fe08d8a59fe67554568727981806e6bc2677a16081ec7/ruamel_yaml_clib-0.2.14-cp314-cp314-win32.whl", hash = "sha256:9b4104bf43ca0cd4e6f738cb86326a3b2f6eef00f417bd1e7efb7bdffe74c539", size = 102394, upload-time = "2025-11-14T21:57:36.703Z" }, + { url = "https://files.pythonhosted.org/packages/bd/e6/a3fa40084558c7e1dc9546385f22a93949c890a8b2e445b2ba43935f51da/ruamel_yaml_clib-0.2.14-cp314-cp314-win_amd64.whl", hash = "sha256:13997d7d354a9890ea1ec5937a219817464e5cc344805b37671562a401ca3008", size = 122673, upload-time = "2025-11-14T21:57:38.177Z" }, ] [[package]]