From 004b18dd9cb37a6c9cb54d49f9e25f26d0bcaaa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Thu, 25 Jul 2024 12:19:19 -0300 Subject: [PATCH] docs: Fix links to Griffe API --- docs/usage/customization.md | 10 +++++----- src/mkdocstrings_handlers/python/handler.py | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/usage/customization.md b/docs/usage/customization.md index 8eedadd1..5e82001e 100644 --- a/docs/usage/customization.md +++ b/docs/usage/customization.md @@ -302,7 +302,7 @@ and the Jinja context available in their scope. Available context: - `config`: The handler configuration (dictionary). -- `module`: The [Module][griffe.dataclasses.Module] instance. +- `module`: The [Module][griffe.Module] instance. #### `class.html` @@ -319,7 +319,7 @@ Available context: Available context: - `config`: The handler configuration (dictionary). -- `class`: The [Class][griffe.dataclasses.Class] instance. +- `class`: The [Class][griffe.Class] instance. #### `function.html` @@ -333,7 +333,7 @@ Available context: Available context: - `config`: The handler configuration (dictionary). -- `function`: The [Function][griffe.dataclasses.Function] instance. +- `function`: The [Function][griffe.Function] instance. #### `attribute.html` @@ -346,7 +346,7 @@ Available context: Available context: - `config`: The handler configuration (dictionary). -- `attribute`: The [Attribute][griffe.dataclasses.Attribute] instance. +- `attribute`: The [Attribute][griffe.Attribute] instance. #### Docstring sections @@ -368,7 +368,7 @@ and `docstring/yields.html`: Available context: -- `section`: The [DocstringSection][griffe.docstrings.dataclasses.DocstringSection] instance (see `DocstringSection*` subclasses). +- `section`: The [DocstringSection][griffe.DocstringSection] instance (see `DocstringSection*` subclasses). ### Syntax highlight in signatures diff --git a/src/mkdocstrings_handlers/python/handler.py b/src/mkdocstrings_handlers/python/handler.py index 9cc60f31..a490e392 100644 --- a/src/mkdocstrings_handlers/python/handler.py +++ b/src/mkdocstrings_handlers/python/handler.py @@ -162,7 +162,7 @@ class PythonHandler(BaseHandler): Attributes: Docstrings options: docstring_style (str): The docstring style to use: `google`, `numpy`, `sphinx`, or `None`. Default: `"google"`. - docstring_options (dict): The options for the docstring parser. See parsers under [`griffe.docstrings`][]. + docstring_options (dict): The options for the docstring parser. See [docstring parsers](https://mkdocstrings.github.io/griffe/reference/docstrings/) and their options in Griffe docs. docstring_section_style (str): The style used to render docstring sections. Options: `table`, `list`, `spacy`. Default: `"table"`. merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`. show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.