8000 docs: Link directly to parser options in Griffe's docs · Viicos/python@ee021be · GitHub
[go: up one dir, main page]

Skip to content

Commit ee021be

Browse files
committed
docs: Link directly to parser options in Griffe's docs
1 parent 1ae8dd8 commit ee021be

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

docs/usage/configuration/docstrings.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -88,21 +88,11 @@ def greet(name: str) -> str:
8888

8989
The options for the docstring parser.
9090

91-
Both Google and Numpy styles offer the following options:
92-
93-
- `ignore_init_summary` ([`bool`][], default `False`): whether to discard
94-
the one-line summary of `__init__` methods.
95-
It is useful when combined with the [`merge_init_into_class`][] option.
96-
- `trim_doctest_flags` ([`bool`][], default `True`): remove the
97-
[doctest flags](https://docs.python.org/3/library/doctest.html#option-flags){ .external }
98-
written as comments in `pycon` snippets within a docstring. These flags are used
99-
to alter the behavior of [`doctest`][] when testing docstrings,
100-
and should not be visible in your docs.
91+
- [Google-style options](https://mkdocstrings.github.io/griffe/docstrings/#parser-options){ .external }
92+
- [Numpydoc-style options](https://mkdocstrings.github.io/griffe/docstrings/#parser-options_1){ .external }
10193

10294
The Sphinx style does not offer any option.
10395

104-
See the API documentation of the available parsers in [`griffe.docstrings`][].
105-
10696
```yaml title="in mkdocs.yml (global configuration)"
10797
plugins:
10898
- mkdocstrings:
@@ -112,7 +102,6 @@ plugins:
112102
docstring_options:
113103
ignore_init_summary: false
114104
trim_doctest_flags: true
115-
116105
```
117106

118107
```md title="or in docs/some_page.md (local configuration)"

0 commit comments

Comments
 (0)
0