Skip to content

Commit

Permalink
docs: Fix links to Griffe API
Browse files Browse the repository at this point in the history
  • Loading branch information
melissawm authored Jul 25, 2024
1 parent ce91d88 commit 004b18d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/usage/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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`

Expand All @@ -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`

Expand All @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/mkdocstrings_handlers/python/handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 004b18d

Please sign in to comment.