Skip to content

Commit 2c695cd

Browse files
committed
docs: Tell how to use the extension
1 parent 5fccd06 commit 2c695cd

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,17 @@ With [`pipx`](https://github.com/pipxproject/pipx):
2020
python3.7 -m pip install --user pipx
2121
pipx install griffe-typingdoc
2222
```
23+
24+
To use the extension in a MkDocs project,
25+
use this configuration:
26+
27+
```yaml
28+
# mkdocs.yml
29+
plugins:
30+
- mkdocstrings:
31+
handlers:
32+
python:
33+
options:
34+
extensions:
35+
- griffe_typingdoc
36+
```

0 commit comments

Comments
 (0)