Skip to content

Commit af66c98

Browse files
committed
docs: Show extensions in tables
1 parent 4f0463e commit af66c98

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

docs/extensions/built-in.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
Built-in extensions are maintained in Griffe's code base. They generally bring support for core features of the Python language or its standard library.
44

5-
Available built-in extensions:
6-
7-
- [`dataclasses`](built-in/dataclasses.md): Support for [`dataclasses`][].
5+
Extension | Description
6+
--------- | -----------
7+
[`dataclasses`](built-in/dataclasses.md) | Support for [`dataclasses`][].

docs/extensions/official.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
Official extensions are developed and maintained within the mkdocstrings organization on GitHub, in separated repositories. They generally bring support for various third-party libraries or other documentation-related features that are part of Python's standard library.
44

5-
Available official extensions:
6-
7-
- [`autodocstringstyle`](official/autodocstringstyle.md): Set docstring style to `auto` for external packages. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
8-
- [`inherited-docstrings`](official/inherited-docstrings.md): Inherit docstrings from parent classes.
9-
- [`public-redundant-aliases`](official/public-redundant-aliases.md): Mark objects imported with redundant aliases as public. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
10-
- [`public-wildcard-imports`](official/public-wildcard-imports.md): Mark wildcard imported objects as public. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
11-
- [`pydantic`](official/pydantic.md): Support for [Pydantic](https://docs.pydantic.dev/latest/) models. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
12-
- [`runtime-objects`](official/runtime-objects.md): Access runtime objects corresponding to each loaded Griffe object through their `extra` attribute. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
13-
- [`sphinx`](official/sphinx.md): Parse [Sphinx](https://www.sphinx-doc.org/)-comments above attributes (`#:`) as docstrings. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders }
14-
- [`typing-doc`](official/typingdoc.md): Support for [PEP 727](https://peps.python.org/pep-0727/)'s [`typing.Doc`][typing_extensions.Doc], "Documentation in Annotated Metadata".
15-
- [`warnings-deprecated`](official/warnings-deprecated.md): Support for [PEP 702](https://peps.python.org/pep-0702/)'s [`warnings.deprecated`][], "Marking deprecations using the type system".
5+
Extension | Description | Sponsors only?
6+
--------- | ----------- | --------------
7+
[`autodocstringstyle`](official/autodocstringstyle.md) | Set docstring style to `auto` for external packages. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders }
8+
[`inherited-docstrings`](official/inherited-docstrings.md) | Inherit docstrings from parent classes.
9+
[`public-redundant-aliases`](official/public-redundant-aliases.md) | Mark objects imported with redundant aliases as public. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders }
10+
[`public-wildcard-imports`](official/public-wildcard-imports.md) | Mark wildcard imported objects as public. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders }
11+
[`pydantic`](official/pydantic.md) | Support for [Pydantic](https://docs.pydantic.dev/latest/) models.
12+
[`runtime-objects`](official/runtime-objects.md) | Access runtime objects corresponding to each loaded Griffe object through their `extra` attribute. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders }
13+
[`sphinx`](official/sphinx.md) | Parse [Sphinx](https://www.sphinx-doc.org/)-comments above attributes (`#:`) as docstrings. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders }
14+
[`typing-doc`](official/typingdoc.md) | Support for [PEP 727](https://peps.python.org/pep-0727/)'s [`typing.Doc`][typing_extensions.Doc], "Documentation in Annotated Metadata".
15+
[`warnings-deprecated`](official/warnings-deprecated.md) | Support for [PEP 702](https://peps.python.org/pep-0702/)'s [`warnings.deprecated`][], "Marking deprecations using the type system".

docs/extensions/third-party.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Third-party extensions are developed and maintained outside of the mkdocstrings organization, by various developers. They generally bring support for third-party libraries.
44

5-
Available third-party extensions:
6-
7-
- [`docstring-inheritance`](third-party/docstring-inheritance.md): A more advanced docstring inheritance utility that also provides a Griffe extension.
8-
- [`fieldz`](third-party/fieldz.md): Support for data-class like objects (dataclasses, pydantic, attrs, etc.) using [fieldz](https://github.com/pyapp-kit/fieldz).
9-
- [`generics`](third-party/generics.md): Resolve generic type parameters as bound types in subclasses.
10-
- [`inherited-method-crossrefs`](third-party/inherited-method-crossrefs.md): Replace docstrings of inherited methods with cross-references to parents.
11-
- [`modernized-annotations`](third-party/modernized-annotations.md): Modernize type annotations by adopting PEP 585 and PEP 604.
5+
Extension | Description
6+
--------- | -----------
7+
[`docstring-inheritance`](third-party/docstring-inheritance.md) | A more advanced docstring inheritance utility that also provides a Griffe extension.
8+
[`fieldz`](third-party/fieldz.md) | Support for data-class like objects (dataclasses, pydantic, attrs, etc.) using [fieldz](https://github.com/pyapp-kit/fieldz).
9+
[`generics`](third-party/generics.md) | Resolve generic type parameters as bound types in subclasses.
10+
[`inherited-method-crossrefs`](third-party/inherited-method-crossrefs.md) | Replace docstrings of inherited methods with cross-references to parents.
11+
[`modernized-annotations`](third-party/modernized-annotations.md) | Modernize type annotations by adopting PEP 585 and PEP 604.
1212

1313
You can find more third-party extensions by exploring the [`griffe-extension` topic on GitHub](https://github.com/topics/griffe-extension). You can also check out the "in-project" extensions (not published to PyPI) used in various projects on GitHub by [searching for "griffe extension" in code](https://github.com/search?q=griffe+Extension+language%3Apython&type=code).

0 commit comments

Comments
 (0)