From 5a26d1234e455c9338a1af71ab63874966221fa8 Mon Sep 17 00:00:00 2001 From: kevin Date: Tue, 28 Jan 2025 08:43:53 +0100 Subject: [PATCH 1/2] Remove model_fields and model_config from sphinx documenation --- docs/conf.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index db3dd2cf6..d4214120b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -82,6 +82,18 @@ "sphinx_rtd_theme", ] + +# Custom processor to filter out Pydantic internal attributes +def skip_pydantic_internals(app, what, name, obj, skip, options): + if name in ("model_fields", "model_config"): + return True + return skip + + +def setup(app): + app.connect("autodoc-skip-member", skip_pydantic_internals) + + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] From 439e795e6fb18b3de06322943cae25ab11640edc Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 6 Feb 2025 14:41:34 +0100 Subject: [PATCH 2/2] Use proper docstring --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d4214120b..3659dd208 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -83,8 +83,11 @@ ] -# Custom processor to filter out Pydantic internal attributes def skip_pydantic_internals(app, what, name, obj, skip, options): + """ + This processor is used to filter out Pydantic internal attributes from the + documentation. + """ if name in ("model_fields", "model_config"): return True return skip