@@ -70,13 +70,13 @@ class UserConfig(BaseModel):
7070
7171Griffe-Pydantic extracts and displays:
7272
73- - **Field names and types** (including Union types, Optional, etc.)
74- - **Field descriptions** from `Field(description=...)`
75- - **Default values** from `Field(default=...)`
76- - **Validation constraints**: `min_length`, `max_length`, `ge`, `le`, `pattern`, etc.
77- - **Required vs optional** fields
78- - **Field examples** from `Field(examples=...)`
79- - **Validators** (custom field validators)
73+ - ** Field names and types** (including Union types, Optional, etc.)
74+ - ** Field descriptions** from ` Field(description=...) `
75+ - ** Default values** from ` Field(default=...) `
76+ - ** Validation constraints** : ` min_length ` , ` max_length ` , ` ge ` , ` le ` , ` pattern ` , etc.
77+ - ** Required vs optional** fields
78+ - ** Field examples** from ` Field(examples=...) `
79+ - ** Validators** (custom field validators)
8080
8181## Class Documentation
8282
@@ -212,11 +212,11 @@ By default, mkdocstrings will discover and document:
212212
213213This will show:
214214
215- - Module docstring
216- - All public classes
217- - All public functions
218- - All public constants
219- - Grouped by category (attributes, classes, functions, etc.)
215+ - Module docstring
216+ - All public classes
217+ - All public functions
218+ - All public constants
219+ - Grouped by category (attributes, classes, functions, etc.)
220220
221221#### Document a Specific Class
222222
@@ -304,11 +304,11 @@ Job management endpoints.
304304
305305This will show:
306306
307- - The router' s docstring
308- - All route handler functions with their HTTP methods, paths, and parameters
309- - Request/response models
310- - Dependencies
311- - Source code links
307+ - The router' s docstring
308+ - All route handler functions with their HTTP methods, paths, and parameters
309+ - Request/response models
310+ - Dependencies
311+ - Source code links
312312
313313# # Best Practices
314314
@@ -458,7 +458,7 @@ class MyClass:
458458
459459## Additional Resources
460460
461- - [Google Style Docstrings Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
462- - [Griffe Documentation](https://mkdocstrings.github.io/griffe/)
463- - [Griffe-Pydantic Documentation](https://mkdocstrings.github.io/griffe-pydantic/)
464- - [mkdocstrings Documentation](https://mkdocstrings.github.io/)
461+ - [Google Style Docstrings Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
462+ - [Griffe Documentation](https://mkdocstrings.github.io/griffe/)
463+ - [Griffe-Pydantic Documentation](https://mkdocstrings.github.io/griffe-pydantic/)
464+ - [mkdocstrings Documentation](https://mkdocstrings.github.io/)
0 commit comments