From af66c983ed5de6b5385c08fc6481e537d39c40d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Thu, 17 Oct 2024 17:24:27 +0200 Subject: [PATCH] docs: Show extensions in tables --- docs/extensions/built-in.md | 6 +++--- docs/extensions/official.md | 22 +++++++++++----------- docs/extensions/third-party.md | 14 +++++++------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/extensions/built-in.md b/docs/extensions/built-in.md index dbe7c146..2c7ddc3e 100644 --- a/docs/extensions/built-in.md +++ b/docs/extensions/built-in.md @@ -2,6 +2,6 @@ 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. -Available built-in extensions: - -- [`dataclasses`](built-in/dataclasses.md): Support for [`dataclasses`][]. +Extension | Description +--------- | ----------- +[`dataclasses`](built-in/dataclasses.md) | Support for [`dataclasses`][]. diff --git a/docs/extensions/official.md b/docs/extensions/official.md index 256a86d0..3d612872 100644 --- a/docs/extensions/official.md +++ b/docs/extensions/official.md @@ -2,14 +2,14 @@ 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. -Available official extensions: - -- [`autodocstringstyle`](official/autodocstringstyle.md): Set docstring style to `auto` for external packages. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } -- [`inherited-docstrings`](official/inherited-docstrings.md): Inherit docstrings from parent classes. -- [`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 } -- [`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 } -- [`pydantic`](official/pydantic.md): Support for [Pydantic](https://docs.pydantic.dev/latest/) models. [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } -- [`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 } -- [`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 } -- [`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". -- [`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". +Extension | Description | Sponsors only? +--------- | ----------- | -------------- +[`autodocstringstyle`](official/autodocstringstyle.md) | Set docstring style to `auto` for external packages. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders } +[`inherited-docstrings`](official/inherited-docstrings.md) | Inherit docstrings from parent classes. +[`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 } +[`public-wildcard-imports`](official/public-wildcard-imports.md) | Mark wildcard imported objects as public. | [:octicons-heart-fill-24:{ .pulse }](../insiders/index.md){ .insiders } +[`pydantic`](official/pydantic.md) | Support for [Pydantic](https://docs.pydantic.dev/latest/) models. +[`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 } +[`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 } +[`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". +[`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". diff --git a/docs/extensions/third-party.md b/docs/extensions/third-party.md index 20ba45a8..def78ce6 100644 --- a/docs/extensions/third-party.md +++ b/docs/extensions/third-party.md @@ -2,12 +2,12 @@ Third-party extensions are developed and maintained outside of the mkdocstrings organization, by various developers. They generally bring support for third-party libraries. -Available third-party extensions: - -- [`docstring-inheritance`](third-party/docstring-inheritance.md): A more advanced docstring inheritance utility that also provides a Griffe extension. -- [`fieldz`](third-party/fieldz.md): Support for data-class like objects (dataclasses, pydantic, attrs, etc.) using [fieldz](https://github.com/pyapp-kit/fieldz). -- [`generics`](third-party/generics.md): Resolve generic type parameters as bound types in subclasses. -- [`inherited-method-crossrefs`](third-party/inherited-method-crossrefs.md): Replace docstrings of inherited methods with cross-references to parents. -- [`modernized-annotations`](third-party/modernized-annotations.md): Modernize type annotations by adopting PEP 585 and PEP 604. +Extension | Description +--------- | ----------- +[`docstring-inheritance`](third-party/docstring-inheritance.md) | A more advanced docstring inheritance utility that also provides a Griffe extension. +[`fieldz`](third-party/fieldz.md) | Support for data-class like objects (dataclasses, pydantic, attrs, etc.) using [fieldz](https://github.com/pyapp-kit/fieldz). +[`generics`](third-party/generics.md) | Resolve generic type parameters as bound types in subclasses. +[`inherited-method-crossrefs`](third-party/inherited-method-crossrefs.md) | Replace docstrings of inherited methods with cross-references to parents. +[`modernized-annotations`](third-party/modernized-annotations.md) | Modernize type annotations by adopting PEP 585 and PEP 604. 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).