From 97cb37bdbce85b4ff746fda529f74fc4d4a417af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Wed, 23 Oct 2024 22:49:40 +0200 Subject: [PATCH] docs: List decorators how-to in user guide main page --- docs/guide/users.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/guide/users.md b/docs/guide/users.md index 106dfeb0..554ea131 100644 --- a/docs/guide/users.md +++ b/docs/guide/users.md @@ -88,7 +88,7 @@ These how-tos will show you how to achieve specific things with Griffe.
-- :octicons-ai-model-24:{ .lg .middle } **Parse docstrings** +- :octicons-ai-model-24:{ .lg .middle } **Parse docstrings** --- @@ -96,12 +96,20 @@ These how-tos will show you how to achieve specific things with Griffe. [:octicons-arrow-right-24: See how to parse docstrings](users/how-to/parse-docstrings.md) -- :material-select:{ .lg .middle } **Selectively inspect objects** +- **@ Support custom decorators** + + --- + + Griffe will rarely support custom decorators through static analysis, but you can easily write extensions to do so. + + [:octicons-arrow-right-24: See how to support custom decorators](users/how-to/support-decorators.md) + +- :material-select:{ .lg .middle } **Selectively inspect objects** --- Sometimes static analysis is not enough, so you might want to use dynamic analysis (inspection) on certain objects. - [:octicons-arrow-right-24: See how selectively inspect objects](users/how-to/selectively-inspect.md) + [:octicons-arrow-right-24: See how to selectively inspect objects](users/how-to/selectively-inspect.md)