Skip to content

Commit bc454d0

Browse files
committed
docs: Add main extensions page
1 parent 7486612 commit bc454d0

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/extensions.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Extensions
2+
3+
Griffe has an extension system that allows Python developers to enhance or modify the data that Griffe collects. To learn more about how to use or develop extensions, please see the [Extending APIs topic](guide/users/extending.md).
4+
5+
We group extensions under three categories:
6+
7+
- [built-in extensions](extensions/built-in.md): maintained directly within Griffe's codebase
8+
- [official extensions](extensions/official.md): maintained in separated repositories, by the authors/maintainers of Griffe
9+
- [third-party extensions](extensions/third-party.md): maintained by other developers

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ nav:
5555
- Project architecture: guide/contributors/architecture.md
5656
- Coverage report: guide/contributors/coverage.md
5757
- Extensions:
58+
- extensions.md
5859
- Built-in:
5960
- extensions/built-in.md
6061
- dataclasses: extensions/built-in/dataclasses.md
@@ -255,7 +256,6 @@ plugins:
255256
loading.md: guide/users/loading.md
256257
expressions.md: guide/users/navigating.md#expressions
257258
best_practices.md: guide/users/recommendations/python-code.md
258-
extensions.md: guide/users/extending.md
259259
docstrings.md: reference/docstrings.md
260260
parsing_docstrings.md: guide/users/how-to/parse-docstrings.md
261261
try_it_out.md: playground.md

0 commit comments

Comments
 (0)