don't auto-doc pydantic's model_computed_fields (class attr)

following from pydantic/pydantic#8437
2bndy5 · Jan 31, 2024 · 042ca81 · 042ca81
1 parent 3cfc245
commit 042ca81
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -96,7 +96,7 @@
 
 autodoc_member_order = "bysource"
 autodoc_default_options = {
-    "exclude-members": "__init__, __new__, model_fields, model_config"
+    "exclude-members": "__init__, __new__, model_fields, model_config, model_computed_fields"
 }
 autodoc_class_signature = "separated"
 add_module_names = False

diff --git a/docs/config.rst b/docs/config.rst
@@ -16,7 +16,7 @@ conf.py file as well. So, the `social_cards <Social_Cards>` option also needs to
 
 .. autoclass:: sphinx_social_cards.validators.Social_Cards
     :members:
-    :exclude-members: model_post_init, model_fields, model_config
+    :exclude-members: model_post_init, model_fields, model_config, model_computed_fields
 
 .. _choosing-a-font:
 
@@ -426,4 +426,4 @@ Debugging Layouts
 
 .. autoclass:: sphinx_social_cards.validators.Debug
     :members:
-    :exclude-members: model_post_init, model_fields, model_config
+    :exclude-members: model_post_init, model_fields, model_config, model_computed_fields
diff --git a/docs/layouts/typography.rst b/docs/layouts/typography.rst
@@ -3,7 +3,7 @@ Layer Typography Attribute
 
 .. autoclass:: sphinx_social_cards.validators.layers.Typography
     :members:
-    :exclude-members: border, model_fields, model_config
+    :exclude-members: border, model_fields, model_config, model_computed_fields
 
     .. autoattribute:: sphinx_social_cards.validators.layers.Typography.border