Skip to content

Commit

Permalink
docs: List decorators how-to in user guide main page
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Oct 23, 2024
1 parent 911ea2d commit 97cb37b
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/guide/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,20 +88,28 @@ These how-tos will show you how to achieve specific things with Griffe.

<div class="grid cards" markdown>

- :octicons-ai-model-24:{ .lg .middle } **Parse docstrings**
- :octicons-ai-model-24:{ .lg .middle } **Parse docstrings**

---

Griffe can be used as a docstring-parsing library.

[: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)

</div>

0 comments on commit 97cb37b

Please sign in to comment.